Партнерский API Маркета

API Яндекс Маркета помогает продавцам автоматизировать и упростить работу с маркетплейсом.

В числе возможностей интеграции:

More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: LATEST
BasePath:
BSD 3-Clause
https://opensource.org/license/bsd-3-clause/

Access

  1. OAuth AuthorizationUrl:https://oauth.yandex.ru/authorizeTokenUrl:

Methods

[ Jump to Models ]

Table of Contents

Bids

BusinessOfferMappings

Businesses

Campaigns

Categories

Chats

Content

Dbs

DeliveryServices

Express

Fbs

Fby

Feedbacks

Feeds

GoodsFeedback

GoodsStats

HiddenOffers

Models

OfferMappings

Offers

OrderBusinessInformation

OrderDelivery

OrderLabels

Orders

OrdersStats

OutletLicenses

Outlets

PriceQuarantine

Prices

Promos

Ratings

Regions

Reports

Returns

Shipments

Stocks

Tariffs

Warehouses

Bids

Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)

Возвращает значения ставок для заданных товаров.

{% note warning "" %}

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsInfoRequest GetBidsInfoRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetBidsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "bids" : [ {
      "sku" : "sku",
      "bid" : 570
    }, {
      "sku" : "sku",
      "bid" : 570
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки. GetBidsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsRecommendationsRequest GetBidsRecommendationsRequest (required)
Body Parameter

Return type

GetBidsRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "recommendations" : [ {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    }, {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Рекомендованные ставки для заданных товаров. GetBidsRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

{% cut "Как в кабинете выглядит кампания, созданная через API" %}

{% endcut %}

При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

BusinessOfferMappings

Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.

{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}

Вначале такой товар нужно распродать или вывезти.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddOffersToArchiveRequest AddOffersToArchiveRequest (required)
Body Parameter

Return type

AddOffersToArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notArchivedOffers" : [ {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    }, {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.

Список успешно добавленных товаров не возвращается.

AddOffersToArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)

Удаляет товары из каталога.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersRequest DeleteOffersRequest (required)
Body Parameter

Return type

DeleteOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)

Восстанавливает товары из архива.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersFromArchiveRequest DeleteOffersFromArchiveRequest (required)
Body Parameter

Return type

DeleteOffersFromArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notUnarchivedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.

Список успешно восстановленных товаров не возвращается.

DeleteOffersFromArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferMappingsRequest GetOfferMappingsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerMappings" : [ {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

{% endnote %}

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingsRequest GetSuggestedOfferMappingsRequest (optional)
Body Parameter

Return type

GetSuggestedOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

GetSuggestedOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.

Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

{% note warning "Правила использования SKU" %}

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingsRequest UpdateOfferMappingsRequest (required)
Body Parameter

Return type

UpdateOfferMappingsResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге. UpdateOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Businesses

Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetBusinessSettingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "settings" : {
      "currency" : "RUR",
      "onlyDefaultPrice" : true
    },
    "info" : {
      "name" : "name",
      "id" : 0
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки кабинета. GetBusinessSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Campaigns

Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignResponse

Example data

Content-Type: application/json
{
  "campaign" : {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазине. GetCampaignResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignLoginsResponse

Example data

Content-Type: application/json
{
  "logins" : [ "logins", "logins" ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список логинов, связанных с магазином. GetCampaignLoginsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)

{% note warning "" %}

Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.

{% endnote %}

Возвращает регион, в котором находится магазин. |⚙️ Лимит: 5 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignRegionResponse

Example data

Content-Type: application/json
{
  "region" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращает регион, в котором находится магазин.

|⚙️ Лимит: 1000 запросов в час| |-|

GetCampaignRegionResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignSettingsResponse

Example data

Content-Type: application/json
{
  "settings" : {
    "showInPremium" : true,
    "showInContext" : true,
    "localRegion" : {
      "delivery" : {
        "schedule" : {
          "customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
          "period" : {
            "fromDate" : "23-09-2022",
            "toDate" : "23-09-2022"
          },
          "customHolidays" : [ "23-09-2022", "23-09-2022" ],
          "weeklyHolidays" : [ 1, 1 ],
          "availableOnHolidays" : true,
          "totalHolidays" : [ "23-09-2022", "23-09-2022" ]
        }
      },
      "name" : "name",
      "id" : 6,
      "type" : "OTHER",
      "deliveryOptionsSource" : "WEB"
    },
    "countryRegion" : 0,
    "shopName" : "shopName",
    "useOpenStat" : true
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки магазина. GetCampaignSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |⚙️ Лимит: 1000 запросов в час| |-|

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Магазины пользователя. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

login (required)
Path Parameter — Логин пользователя. default: null

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазинах. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Categories

Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)

Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.

Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.

Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesMaxSaleQuantumRequest GetCategoriesMaxSaleQuantumRequest (required)
Body Parameter

Return type

GetCategoriesMaxSaleQuantumResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  }, {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  } ],
  "errors" : [ {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  }, {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Лимит на установку кванта и минимального количества товаров. GetCategoriesMaxSaleQuantumResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/tree
Дерево категорий (getCategoriesTree)

Возвращает дерево категорий Маркета.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesRequest GetCategoriesRequest (optional)
Body Parameter

Return type

GetCategoriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Категории Маркета. GetCategoriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Chats

Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)

Создает новый чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateChatRequest CreateChatRequest (required)
Body Parameter

Return type

CreateChatResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chatId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: чат создан. CreateChatResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)

Возвращает историю сообщений в чате с покупателем.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatHistoryRequest GetChatHistoryRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatHistoryResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderId" : 0,
    "messages" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

История сообщений успешно получена. GetChatHistoryResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)

Возвращает ваши чаты с покупателями.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatsRequest GetChatsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chats" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список чатов. GetChatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)

Отправляет файл в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Form parameters

file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что файл отправлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)

Отправляет сообщение в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SendMessageToChatRequest SendMessageToChatRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что сообщение отправлено. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Content

Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)

Возвращает список характеристик с допустимыми значениями для заданной категории.

|⚙️ Лимит: 50 категорий в минуту | |-|

Path parameters

categoryId (required)
Path Parameter

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

default: null format: int64

Return type

GetCategoryContentParametersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parameters" : [ {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    }, {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    } ],
    "categoryId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список характеристик товаров из заданной категории. GetCategoryContentParametersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)

Возвращает сведения о состоянии контента для заданных товаров:

|⚙️ Лимит: 600 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferCardsContentStatusRequest GetOfferCardsContentStatusRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferCardsContentStatusResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerCards" : [ {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    }, {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о карточках указанных товаров. GetOfferCardsContentStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)

Редактирует характеристики товара, которые специфичны для категории, к которой он относится.

{% note warning "Здесь только то, что относится к конкретной категории" %}

Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferContentRequest UpdateOfferContentRequest (required)
Body Parameter

Return type

UpdateOfferContentResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос выполнен корректно, данные обработаны.

{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

{% endnote %}

Если в status вернулось ERROR, убедитесь, что:

Найти проблемы помогут поля errors и warnings.

UpdateOfferContentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Dbs

Up
put /campaigns/{campaignId}/orders/{orderId}/cancellation/accept
Отмена заказа покупателем (acceptOrderCancellation)

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки.

Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.

Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут.

Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене.

Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.

|⚙️ Лимит: 500 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AcceptOrderCancellationRequest AcceptOrderCancellationRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ на отмену заказа был успешно передан. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)

Скрывает товары магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddHiddenOffersRequest AddHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки скрытия получены и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.

{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}

Вначале такой товар нужно распродать или вывезти.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddOffersToArchiveRequest AddOffersToArchiveRequest (required)
Body Parameter

Return type

AddOffersToArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notArchivedOffers" : [ {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    }, {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.

Список успешно добавленных товаров не возвращается.

AddOffersToArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

|⚙️ Лимит: 100 запросов в минуту| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CalculateTariffsRequest CalculateTariffsRequest (required)
Body Parameter

Return type

CalculateTariffsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Стоимость услуг. CalculateTariffsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.

Основная цена задается в каталоге и действует во всех магазинах кабинета.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)

Создает новый чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateChatRequest CreateChatRequest (required)
Body Parameter

Return type

CreateChatResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chatId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: чат создан. CreateChatResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/outlets
Создание точки продаж (createOutlet)

Создает точку продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ChangeOutletRequest ChangeOutletRequest (required)
Body Parameter

Return type

CreateOutletResponse

Example data

Content-Type: application/json
{
  "result" : {
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о созданной точке продаж. CreateOutletResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)

Удаляет заданные товары из заданного магазина.

{% note warning "Запрос удаляет товары именно из конкретного магазина" %}

На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.

{% endnote %}

Товар не получится удалить, если он хранится на складах Маркета.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteCampaignOffersRequest DeleteCampaignOffersRequest (required)
Body Parameter

Return type

DeleteCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)

Удаляет комментарий магазина.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteGoodsFeedbackCommentRequest DeleteGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)

Возобновляет показ скрытых вами товаров магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteHiddenOffersRequest DeleteHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Показ товаров возобновлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)

Удаляет товары из каталога.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersRequest DeleteOffersRequest (required)
Body Parameter

Return type

DeleteOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)

Восстанавливает товары из архива.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersFromArchiveRequest DeleteOffersFromArchiveRequest (required)
Body Parameter

Return type

DeleteOffersFromArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notUnarchivedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.

Список успешно восстановленных товаров не возвращается.

DeleteOffersFromArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
delete /campaigns/{campaignId}/outlets/{outletId}
Удаление точки продаж (deleteOutlet)

Удаляет точку продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
delete /campaigns/{campaignId}/outlets/licenses
Удаление лицензий для точек продаж (deleteOutletLicenses)

Удаляет информацию о лицензиях для точек продаж.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)

Убирает товары из акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeletePromoOffersRequest DeletePromoOffersRequest (required)
Body Parameter

Return type

DeletePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат удаления товаров из акции. DeletePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)

Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateBoostConsolidatedRequest GenerateBoostConsolidatedRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)

Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

{% note info "Значение -1 в отчете" %}

Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.

{% endnote %}

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateCompetitorsPositionReportRequest GenerateCompetitorsPositionReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)

Запускает генерацию отчета по отзывам о товарах. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsFeedbackRequest GenerateGoodsFeedbackRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 1000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateMassOrderLabelsRequest GenerateMassOrderLabelsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все коробки. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)

Запускает генерацию отчета «Цены на рынке».

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GeneratePricesReportRequest GeneratePricesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShelfsStatisticsRequest GenerateShelfsStatisticsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShowsSalesReportRequest GenerateShowsSalesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateStocksOnWarehousesReportRequest GenerateStocksOnWarehousesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-----------------------------|---------------------------------| |По дате начисления услуги |dateFrom и dateTo | |По дате формирования акта |year и month |

Заказать отчеты обоих типов одним запросом нельзя.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedMarketplaceServicesReportRequest GenerateUnitedMarketplaceServicesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-------------------------|---------------------------------------| |О платежах за период |dateFrom и dateTo | |О платежном поручении |bankOrderId и bankOrderDateTime |

Заказать отчеты обоих типов одним запросом нельзя.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedNettingReportRequest GenerateUnitedNettingReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)

Запускает генерацию отчета по заказам за заданный период. Что это за отчет

{% note info "" %}

Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам

{% endnote %}

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedOrdersRequest GenerateUnitedOrdersRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter

Номер сегмента с результатами.

Значение по умолчанию: 0.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.

{% endnote %}

default: null format: int32

Return type

GetAllOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetAllOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)

Возвращает значения ставок для заданных товаров.

{% note warning "" %}

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsInfoRequest GetBidsInfoRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetBidsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "bids" : [ {
      "sku" : "sku",
      "bid" : 570
    }, {
      "sku" : "sku",
      "bid" : 570
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки. GetBidsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsRecommendationsRequest GetBidsRecommendationsRequest (required)
Body Parameter

Return type

GetBidsRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "recommendations" : [ {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    }, {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Рекомендованные ставки для заданных товаров. GetBidsRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetBusinessSettingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "settings" : {
      "currency" : "RUR",
      "onlyDefaultPrice" : true
    },
    "info" : {
      "name" : "name",
      "id" : 0
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки кабинета. GetBusinessSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignResponse

Example data

Content-Type: application/json
{
  "campaign" : {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазине. GetCampaignResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignLoginsResponse

Example data

Content-Type: application/json
{
  "logins" : [ "logins", "logins" ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список логинов, связанных с магазином. GetCampaignLoginsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCampaignOffersRequest GetCampaignOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    }, {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, размещенных в заданном магазине. GetCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)

{% note warning "" %}

Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.

{% endnote %}

Возвращает регион, в котором находится магазин. |⚙️ Лимит: 5 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignRegionResponse

Example data

Content-Type: application/json
{
  "region" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращает регион, в котором находится магазин.

|⚙️ Лимит: 1000 запросов в час| |-|

GetCampaignRegionResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignSettingsResponse

Example data

Content-Type: application/json
{
  "settings" : {
    "showInPremium" : true,
    "showInContext" : true,
    "localRegion" : {
      "delivery" : {
        "schedule" : {
          "customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
          "period" : {
            "fromDate" : "23-09-2022",
            "toDate" : "23-09-2022"
          },
          "customHolidays" : [ "23-09-2022", "23-09-2022" ],
          "weeklyHolidays" : [ 1, 1 ],
          "availableOnHolidays" : true,
          "totalHolidays" : [ "23-09-2022", "23-09-2022" ]
        }
      },
      "name" : "name",
      "id" : 6,
      "type" : "OTHER",
      "deliveryOptionsSource" : "WEB"
    },
    "countryRegion" : 0,
    "shopName" : "shopName",
    "useOpenStat" : true
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки магазина. GetCampaignSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |⚙️ Лимит: 1000 запросов в час| |-|

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Магазины пользователя. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

login (required)
Path Parameter — Логин пользователя. default: null

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазинах. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)

Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.

Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.

Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesMaxSaleQuantumRequest GetCategoriesMaxSaleQuantumRequest (required)
Body Parameter

Return type

GetCategoriesMaxSaleQuantumResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  }, {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  } ],
  "errors" : [ {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  }, {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Лимит на установку кванта и минимального количества товаров. GetCategoriesMaxSaleQuantumResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/tree
Дерево категорий (getCategoriesTree)

Возвращает дерево категорий Маркета.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesRequest GetCategoriesRequest (optional)
Body Parameter

Return type

GetCategoriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Категории Маркета. GetCategoriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)

Возвращает список характеристик с допустимыми значениями для заданной категории.

|⚙️ Лимит: 50 категорий в минуту | |-|

Path parameters

categoryId (required)
Path Parameter

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

default: null format: int64

Return type

GetCategoryContentParametersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parameters" : [ {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    }, {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    } ],
    "categoryId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список характеристик товаров из заданной категории. GetCategoryContentParametersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)

Возвращает историю сообщений в чате с покупателем.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatHistoryRequest GetChatHistoryRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatHistoryResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderId" : 0,
    "messages" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

История сообщений успешно получена. GetChatHistoryResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)

Возвращает ваши чаты с покупателями.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatsRequest GetChatsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chats" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список чатов. GetChatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования. |⚙️ Лимит: 5 000 запросов в час| |-|

Return type

GetDeliveryServicesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : [ {
      "name" : "name",
      "id" : 0
    }, {
      "name" : "name",
      "id" : 0
    } ]
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о службах доставки. GetDeliveryServicesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

GetFeedResponse

Example data

Content-Type: application/json
{
  "feed" : {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о прайс-листе. GetFeedResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Query parameters

limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

default: null format: date-time
published_time_to (optional)
Query Parameter

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

{% endnote %}

default: null format: date-time
status (optional)
Query Parameter

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.
default: null

Return type

GetFeedIndexLogsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feed" : {
      "id" : 0
    },
    "total" : 2,
    "indexLogRecords" : [ {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    }, {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по индексации прайс-листа. GetFeedIndexLogsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает новые и обновленные отзывы о магазине на Маркете.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.

|⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter

Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: ГГГГ-ММ-ДД.

default: null format: date

Return type

GetFeedbackListResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "feedbackList" : [ {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    }, {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов для магазина. GetFeedbackListResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetFeedsResponse

Example data

Content-Type: application/json
{
  "feeds" : [ {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }, {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список прайс-листов. GetFeedsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)

Возвращает комментарии к отзыву.

Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackCommentsRequest GetGoodsFeedbackCommentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackCommentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "comments" : [ {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    }, {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Дерево комментариев к отзыву. GetGoodsFeedbackCommentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)

Возвращает все отзывы о товарах продавца по указанным фильтрам.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.

Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackRequest GetGoodsFeedbackRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feedbacks" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов. GetGoodsFeedbackResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsStatsRequest GetGoodsStatsRequest (required)
Body Parameter

Return type

GetGoodsStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "shopSkus" : [ {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по товарам. GetGoodsStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)

Возвращает список скрытых вами товаров для заданного магазина.

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

default: null format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetHiddenOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "hiddenOffers" : [ {
      "offerId" : "offerId"
    }, {
      "offerId" : "offerId"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о скрытых вами товарах. GetHiddenOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /models/{modelId}
Информация об одной модели (getModel)

Возвращает информацию о модели товара.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Path parameters

modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null

Return type

GetModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "regionId" : 0,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о модели. GetModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /models/{modelId}/offers
Список предложений для одной модели (getModelOffers)

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.

Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.

Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.

Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Path parameters

modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
orderByPrice (optional)
Query Parameter

Направление сортировки по цене.

Возможные значения:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

default: null
count (optional)
Query Parameter — Количество предложений на странице ответа. default: 10 format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32

Return type

GetModelsOffersResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  }, {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  } ],
  "regionId" : 7,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список предложений для модели. GetModelsOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /models
Информация о нескольких моделях (getModels)

Возвращает информацию о моделях товаров.

В одном запросе можно получить информацию не более чем о 100 моделях.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetModelsRequest GetModelsRequest (required)
Body Parameter

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null

Return type

GetModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "regionId" : 0,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о моделях. GetModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /models/offers
Список предложений для нескольких моделей (getModelsOffers)

Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе.

Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.

Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются.

В одном запросе можно получить информацию о предложениях не более чем для 100 моделей.

Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetModelsRequest GetModelsRequest (required)
Body Parameter

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
orderByPrice (optional)
Query Parameter

Направление сортировки по цене.

Возможные значения:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

default: null

Return type

GetModelsOffersResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  }, {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  } ],
  "regionId" : 7,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список предложений для моделей. GetModelsOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)

Возвращает сведения о состоянии контента для заданных товаров:

|⚙️ Лимит: 600 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferCardsContentStatusRequest GetOfferCardsContentStatusRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferCardsContentStatusResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerCards" : [ {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    }, {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о карточках указанных товаров. GetOfferCardsContentStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:

Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.

{% note info %}

Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter

Ваш SKU товара.

Параметр может быть указан несколько раз, например:

...shop_sku=123&shop_sku=129&shop_sku=141...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter

Фильтрация по статусу публикации товара:

  • READY — товар прошел модерацию.
  • IN_WORK — товар проходит модерацию.
  • NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
  • NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
  • REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
  • SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
  • OTHER — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
availability (optional)
Query Parameter

Фильтрация по планам поставок товара:

  • ACTIVE — поставки будут.
  • INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
  • DELISTED — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
category_id (optional)
Query Parameter

Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
vendor (optional)
Query Parameter

Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerMappingEntries" : [ {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    }, {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferMappingsRequest GetOfferMappingsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerMappings" : [ {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)

Метод возвращает рекомендации нескольких типов.

1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.

Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено

2. Оценка привлекательности цен на витрине.

Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferRecommendationsRequest GetOfferRecommendationsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerRecommendations" : [ {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    }, {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с рекомендациями. GetOfferRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.

Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

{% note info %}

Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

{% endnote %}

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

query (optional)
Query Parameter

Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

default: null
currency (optional)
Query Parameter

Валюта, в которой указана цена предложения.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

default: null
matched (optional)
Query Parameter

Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

  • 0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

  • 1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)

Возвращает информацию о заказе.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказе. GetOrderResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "organizationName" : "organizationName",
    "organizationJurAddress" : "organizationJurAddress",
    "inn" : "inn",
    "kpp" : "kpp"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetBusinessBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)

Возвращает информацию о документах по идентификатору заказа.

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessDocumentsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "sf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "torgTwelve" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "upd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ukd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ksf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о документах. GetBusinessDocumentsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/buyer
Информация о покупателе — физическом лице (getOrderBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "lastName" : "lastName",
    "firstName" : "firstName",
    "phone" : "phone",
    "middleName" : "middleName",
    "id" : "id",
    "type" : "PERSON"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetOrderBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderLabelsDataResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parcelBoxLabels" : [ {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    }, {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    } ],
    "orderId" : 0,
    "placesNumber" : 6,
    "url" : "url"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация для печати ярлыков. GetOrderLabelsDataResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.

Доступна фильтрация по нескольким характеристикам заказов:

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.

Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter

Статус заказа:

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
substatus (optional)
Query Parameter

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.
  • SHIPPED — заказ передан службе доставки.

Возможные значения для заказа в статусе CANCELLED:

  • DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

  • USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.

  • CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате оформления.

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.

Значение по умолчанию: 30 дней назад от текущей даты.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате оформления.

Показываются заказы, созданные до 00:00 указанного дня.

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.

Значение по умолчанию: текущая дата.

default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date
supplierShipmentDateTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date
updatedAtFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date-time
updatedAtTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter

Фильтрация заказов по типам:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

default: false
hasCis (optional)
Query Parameter

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.

  • false — нет.

Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter

Только для модели DBS

Фильтрация заказов по наличию запросов покупателей на отмену.

При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.

Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

default: false
onlyEstimatedDelivery (optional)
Query Parameter

Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:

  • true — возвращаются только заказы с неподтвержденной датой доставки.
  • false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "orders" : [ {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }, {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах. GetOrdersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

{% note info "" %}

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

{% endnote %}

В одном запросе можно получить информацию не более чем по 200 заказам.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOrdersStatsRequest GetOrdersStatsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    }, {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по заказам. GetOrdersStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets/{outletId}
Информация об одной точке продаж (getOutlet)

Возвращает информацию о точках продаж магазина.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Return type

GetOutletResponse

Example data

Content-Type: application/json
{
  "outlet" : {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о точке продаж. GetOutletResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets/licenses
Информация о лицензиях для точек продаж (getOutletLicenses)

Возвращает информацию о лицензиях для точек продаж.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

outletIds (optional)
Query Parameter

Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.

default: null format: int64
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64

Return type

GetOutletLicensesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "licenses" : [ {
      "licenseType" : "ALCOHOL",
      "number" : "number",
      "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
      "checkStatus" : "NEW",
      "outletId" : 6,
      "id" : 0,
      "dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
      "checkComment" : "checkComment"
    }, {
      "licenseType" : "ALCOHOL",
      "number" : "number",
      "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
      "checkStatus" : "NEW",
      "outletId" : 6,
      "id" : 0,
      "dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
      "checkComment" : "checkComment"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденные лицензии собственных точек продаж. GetOutletLicensesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets
Информация о нескольких точках продаж (getOutlets)

Возвращает список точек продаж магазина.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
region_id (optional)
Query Parameter — Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода GET regions. default: null format: int64
shop_outlet_code (optional)
Query Parameter — Идентификатор точки продаж, присвоенный магазином. default: null
regionId (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Для указания региона используйте region_id.

{% endnote %}

default: null format: int64

Return type

GetOutletsResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "outlets" : [ {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  }, {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  } ],
  "paging" : {
    "prevPageToken" : "prevPageToken",
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о точках продаж. GetOutletsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.

{% endnote %}

Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.

{% note info %}

Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.

{% endnote %}

Способы установки цен описаны в Справке Маркета для продавцов.

|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false

Return type

GetPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "total" : 6,
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список всех товаров с установленными ценами. GetPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)

Возвращает список цен на указанные товары в магазине.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPricesByOfferIdsRequest GetPricesByOfferIdsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPricesByOfferIdsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с установленными для заданного магазина ценами. GetPricesByOfferIdsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)

Возвращает список товаров, которые участвуют или могут участвовать в акции.

{% note warning %}

В параметре limit не передавайте значение больше 500.

{% endnote %}

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromoOffersRequest GetPromoOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    }, {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, которые участвуют или могут участвовать в акции. GetPromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)

Возвращает информацию об акциях Маркета.

По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromosRequest GetPromosRequest (optional)
Body Parameter

Return type

GetPromosResponse

Example data

Content-Type: application/json
{
  "result" : {
    "promos" : [ {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    }, {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список акций Маркета. GetPromosResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос POST businesses/{businessId}/ratings/quality.

|⚙️ Лимит: 100000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetQualityRatingDetailsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "affectedOrders" : [ {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    }, {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах, которые повлияли на индекс качества. GetQualityRatingDetailsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQualityRatingRequest GetQualityRatingRequest (required)
Body Parameter

Return type

GetQualityRatingResponse

Example data

Content-Type: application/json
{
  "result" : {
    "campaignRatings" : [ {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    }, {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значение индекса качества магазинов и его составляющие. GetQualityRatingResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null

Return type

GetReportInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
    "file" : "file",
    "generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
    "subStatus" : "NO_DATA",
    "status" : "PENDING",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус генерации отчета и ссылка, если она уже есть.

{% note tip %}

Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.

{% endnote %}

 

GetReportInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)

Получает информацию по одному невыкупу или возврату.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

GetReturnResponse

Example data

Content-Type: application/json
{
  "result" : {
    "updateDate" : "2000-01-23T04:56:07.000+00:00",
    "fastReturn" : true,
    "orderId" : 6,
    "shipmentRecipientType" : "SHOP",
    "refundStatus" : "STARTED_BY_USER",
    "logisticPickupPoint" : {
      "logisticPartnerId" : 5,
      "address" : {
        "country" : "Россия",
        "city" : "Москва",
        "street" : "Стрелецкая улица",
        "postcode" : "123518",
        "house" : "9к2"
      },
      "instruction" : "instruction",
      "name" : "name",
      "id" : 1,
      "type" : "WAREHOUSE"
    },
    "id" : 0,
    "creationDate" : "2000-01-23T04:56:07.000+00:00",
    "items" : [ {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    }, {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    } ],
    "returnType" : "UNREDEEMED",
    "shipmentStatus" : "CREATED",
    "refundAmount" : 5
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. GetReturnResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)

Загружает заявление покупателя на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Заявление на возврат. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)

Получает фотографии, которые покупатель приложил к заявлению на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Фотография возврата. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

default: null format: int64
statuses (optional)
Query Parameter

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

default: null
type (optional)
Query Parameter

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
from_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте fromDate.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date
to_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте toDate.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date

Return type

GetReturnsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "returns" : [ {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    }, {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Постраничные возвраты партнера. GetReturnsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)

Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).

{% note info "По умолчанию данные по оборачивамости не возращаются" %}

Чтобы они были в ответе, передавайте true в поле withTurnover.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetWarehouseStocksRequest GetWarehouseStocksRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetWarehouseStocksResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    }, {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Остатки товаров на складах. GetWarehouseStocksResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.

{% endnote %}

Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.

Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:

##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##

Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.

Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.

В одном запросе можно получить не более 500 рекомендаций.

|⚙️ Лимит: 100 000 рекомендаций в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingEntriesRequest GetSuggestedOfferMappingEntriesRequest (required)
Body Parameter

Return type

GetSuggestedOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    }, {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetSuggestedOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

{% endnote %}

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingsRequest GetSuggestedOfferMappingsRequest (optional)
Body Parameter

Return type

GetSuggestedOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

GetSuggestedOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте отчет «Цены на рынке».

{% endnote %}

{% note warning "" %}

Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.

{% endnote %}

Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.

Товары, для которых нужно получить цены, передаются в теле POST-запроса.

Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.

Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.

Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.

Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SuggestPricesRequest SuggestPricesRequest (required)
Body Parameter

Return type

SuggestPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    }, {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список цен для продвижения на Маркете. SuggestPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)

Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны

Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    } ],
    "warehouseGroups" : [ {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    }, {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов и групп складов. GetWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods
Передача ключей цифровых товаров (provideOrderDigitalCodes)

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED.

Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.

Если в один заказ входят несколько ключей, передавайте их все в одном запросе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderDigitalCodesRequest ProvideOrderDigitalCodesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Передает Маркету коды маркировки для единиц товара в указанном заказе.

Принимаются коды следующих типов:

{% note warning %}

Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.

{% endnote %}

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderItemIdentifiersRequest ProvideOrderItemIdentifiersRequest (required)
Body Parameter

Return type

ProvideOrderItemIdentifiersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "items" : [ {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    }, {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах. ProvideOrderItemIdentifiersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

{% cut "Как в кабинете выглядит кампания, созданная через API" %}

{% endcut %}

При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

  1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
  2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh.
  3. Маркет начинает обновление данных магазина на сервисе.

{% note alert %}

Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

{% endnote %}

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /models
Поиск модели товара (searchModels)

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска.

В одном запросе можно получить информацию не более чем о 100 моделях.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Query parameters

query (required)
Query Parameter — Поисковый запрос по названию модели товара. default: null
regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

SearchModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "regionId" : 5,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о моделях. SearchModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetRegionWithChildrenResponse

Example data

Content-Type: application/json
{
  "regions" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  },
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Регионы, являющиеся дочерними к указанному в запросе. GetRegionWithChildrenResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)

Возвращает информацию о регионе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденный регион. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions
Поиск регионов по их имени (searchRegionsByName)

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Query parameters

name (required)
Query Parameter

Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список найденных регионов. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)

Отправляет файл в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Form parameters

file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что файл отправлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)

Отправляет сообщение в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SendMessageToChatRequest SendMessageToChatRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что сообщение отправлено. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetFeedParamsRequest SetFeedParamsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)

{% note tip "Подходит и для DBS" %}

Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.

{% endnote %}

Позволяет выполнить три операции:

Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.

Как передать информацию о распределении товаров

В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:

⚠️ Одна коробка не может содержать и товары целиком, и части товаров.

Как передавать коды маркировки

Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?

Принимаются коды следующих типов:

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.

Как удалить товар из заказа

Чтобы удалить товар из заказа:

  1. Добавьте в запрос allowRemove: true.
  2. Передайте распределение по коробкам без товара, который нужно удалить.

{% note warning "Удаление нельзя отменить" %}

Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.

{% endnote %}

Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.

Нельзя удалить или уменьшить количество товара, если он:

Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Примеры

{% cut "Товар умещается в коробку" %}

Вот как будет выглядеть запрос, если в одной коробке едут:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "fullCount": 3,
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        },
                        {
                            "cis": "010304109478gftJ14545762!\u001dhGt264"
                        },
                        {
                            "cis": "010304109478fRs28323ks23!\u001dhet201"
                        }
                    ]
                },
                {
                    "id": 654321,
                    "fullCount": 1
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Товар едет в разных коробках" %}

Вот как будет выглядеть запрос, если товар едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}

Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderBoxLayoutRequest SetOrderBoxLayoutRequest (required)
Body Parameter

Return type

SetOrderBoxLayoutResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    }, {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков. SetOrderBoxLayoutResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/date
Изменение даты доставки заказа (setOrderDeliveryDate)

Метод изменяет дату доставки заказа в статусе PROCESSING или DELIVERY. Для заказов с другими статусами дату доставки изменить нельзя.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderDeliveryDateRequest SetOrderDeliveryDateRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Успешное изменение даты доставки. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/delivery/track
Передача трек‑номера посылки (setOrderDeliveryTrackCode)

{% note warning "Этот запрос только для DBS" %}

Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти.

{% endnote %}

Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки.

Передать трек‑номер можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderDeliveryTrackCodeRequest SetOrderDeliveryTrackCodeRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Трек‑номер посылки и идентификатор службы доставки были успешно переданы. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.

Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.

Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.

Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.

{% cut "Как было раньше" %}

Структура тела PUT-запроса:

{
  "boxes":
  [
    {
      "fulfilmentId": "{string}",
      "weight": {int64},
      "width": {int64},
      "height": {int64},
      "depth": {int64},
      "items":
      [
        {
          "id": {int64},
          "count": {int32}
        },
        ...
      ]
    },
    ...
  ]
}

| Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | boxes | | Список грузовых мест. |

Параметры, вложенные в boxes | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. | | weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | width | Int64 | Ширина грузового места в сантиметрах. | | height | Int64 | Высота грузового места в сантиметрах. | | depth | Int64 | Глубина грузового места в сантиметрах. | | items | Int64 | Список товаров в грузовом месте. |

Параметры, вложенные в items | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | id | Int64 | Идентификатор товара в рамках заказа. | | count | Int32 | Количество единиц товара в грузовом месте. |

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderShipmentBoxesRequest SetOrderShipmentBoxesRequest (required)
Body Parameter

Return type

SetOrderShipmentBoxesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    }, {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество грузомест записано. SetOrderShipmentBoxesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision
Принятие или изменение решения по возврату (setReturnDecision)

Выбирает решение по возврату от покупателя. После этого для подтверждения решения нужно выполнить запрос POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetReturnDecisionRequest SetReturnDecisionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов POST businesses/{businessId}/goods-feedback.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SkipGoodsFeedbackReactionRequest SkipGoodsFeedbackReactionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit
Подтверждение решения по возврату (submitReturnDecision)

Подтверждает выбранное решение по возврату, отправленное в запросе POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)

Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateBusinessPricesRequest UpdateBusinessPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateCampaignOffersRequest UpdateCampaignOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.

Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.

Чтобы добавить комментарий к другому комментарию, передайте:

Чтобы изменить комментарий, передайте:

Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateGoodsFeedbackCommentRequest UpdateGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

UpdateGoodsFeedbackCommentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "author" : {
      "name" : "name",
      "type" : "USER"
    },
    "id" : 0,
    "text" : "text",
    "canModify" : true,
    "parentId" : 6,
    "status" : "PUBLISHED"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о добавленном или измененном комментарии. UpdateGoodsFeedbackCommentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)

Редактирует характеристики товара, которые специфичны для категории, к которой он относится.

{% note warning "Здесь только то, что относится к конкретной категории" %}

Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferContentRequest UpdateOfferContentRequest (required)
Body Parameter

Return type

UpdateOfferContentResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос выполнен корректно, данные обработаны.

{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

{% endnote %}

Если в status вернулось ERROR, убедитесь, что:

Найти проблемы помогут поля errors и warnings.

UpdateOfferContentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.

Информацию о товарах нужно передать в теле POST-запроса.

У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:

В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.

Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

В одном запросе можно добавить не более 500 товаров.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingEntryRequest UpdateOfferMappingEntryRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.

Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

{% note warning "Правила использования SKU" %}

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingsRequest UpdateOfferMappingsRequest (required)
Body Parameter

Return type

UpdateOfferMappingsResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге. UpdateOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:

Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.

Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.

Чтобы полностью удалить товар из заказа:

Нельзя удалить или уменьшить количество товара, если он:

Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Возврат денег покупателю

Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderItemRequest UpdateOrderItemRequest (required)
Body Parameter

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)

Изменяет статус заказа. Возможные изменения статусов:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusRequest UpdateOrderStatusRequest (required)
Body Parameter

Return type

UpdateOrderStatusResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В случае успешного изменения статуса заказа возвращается обновленная информация о заказе. UpdateOrderStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)

Изменяет статусы нескольких заказов.

Возможные изменения статусов:

Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusesRequest UpdateOrderStatusesRequest (required)
Body Parameter

Return type

UpdateOrderStatusesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    }, {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращается информация об обновленных статусах заказов. UpdateOrderStatusesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit
Продление срока хранения заказа (updateOrderStorageLimit)

Продлевает срок хранения заказа в пункте выдачи продавца.

Заказ должен быть в статусе PICKUP. Продлить срок можно только один раз, не больше чем на 30 дней.

Новый срок хранения можно получить в параметре outletStorageLimitDate запроса GET campaigns/{campaignId}/orders/{orderId}.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStorageLimitRequest UpdateOrderStorageLimitRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/outlets/{outletId}
Изменение информации о точке продаж (updateOutlet)

Изменяет информацию о точке продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ChangeOutletRequest ChangeOutletRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/outlets/licenses
Создание и изменение лицензий для точек продаж (updateOutletLicenses)

Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя.

Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOutletLicenseRequest UpdateOutletLicenseRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePricesRequest UpdatePricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePromoOffersRequest UpdatePromoOffersRequest (required)
Body Parameter

Return type

UpdatePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ],
    "warningOffers" : [ {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    }, {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат добавления товаров в акцию или обновления их цен. UpdatePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)

Передает данные об остатках товаров на витрине.

Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateStocksRequest UpdateStocksRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

DeliveryServices

Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования. |⚙️ Лимит: 5 000 запросов в час| |-|

Return type

GetDeliveryServicesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : [ {
      "name" : "name",
      "id" : 0
    }, {
      "name" : "name",
      "id" : 0
    } ]
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о службах доставки. GetDeliveryServicesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Express

Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)

Скрывает товары магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddHiddenOffersRequest AddHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки скрытия получены и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.

{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}

Вначале такой товар нужно распродать или вывезти.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddOffersToArchiveRequest AddOffersToArchiveRequest (required)
Body Parameter

Return type

AddOffersToArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notArchivedOffers" : [ {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    }, {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.

Список успешно добавленных товаров не возвращается.

AddOffersToArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

|⚙️ Лимит: 100 запросов в минуту| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CalculateTariffsRequest CalculateTariffsRequest (required)
Body Parameter

Return type

CalculateTariffsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Стоимость услуг. CalculateTariffsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.

Основная цена задается в каталоге и действует во всех магазинах кабинета.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)

Создает новый чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateChatRequest CreateChatRequest (required)
Body Parameter

Return type

CreateChatResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chatId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: чат создан. CreateChatResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)

Удаляет заданные товары из заданного магазина.

{% note warning "Запрос удаляет товары именно из конкретного магазина" %}

На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.

{% endnote %}

Товар не получится удалить, если он хранится на складах Маркета.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteCampaignOffersRequest DeleteCampaignOffersRequest (required)
Body Parameter

Return type

DeleteCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)

Удаляет комментарий магазина.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteGoodsFeedbackCommentRequest DeleteGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)

Возобновляет показ скрытых вами товаров магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteHiddenOffersRequest DeleteHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Показ товаров возобновлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)

Удаляет товары из каталога.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersRequest DeleteOffersRequest (required)
Body Parameter

Return type

DeleteOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)

Восстанавливает товары из архива.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersFromArchiveRequest DeleteOffersFromArchiveRequest (required)
Body Parameter

Return type

DeleteOffersFromArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notUnarchivedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.

Список успешно восстановленных товаров не возвращается.

DeleteOffersFromArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)

Убирает товары из акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeletePromoOffersRequest DeletePromoOffersRequest (required)
Body Parameter

Return type

DeletePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат удаления товаров из акции. DeletePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)

Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateBoostConsolidatedRequest GenerateBoostConsolidatedRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)

Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

{% note info "Значение -1 в отчете" %}

Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.

{% endnote %}

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateCompetitorsPositionReportRequest GenerateCompetitorsPositionReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)

Запускает генерацию отчета по отзывам о товарах. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsFeedbackRequest GenerateGoodsFeedbackRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)

Запускает генерацию отчета по реализации за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsRealizationReportRequest GenerateGoodsRealizationReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 1000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateMassOrderLabelsRequest GenerateMassOrderLabelsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все коробки. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)

Запускает генерацию отчета «Цены на рынке».

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GeneratePricesReportRequest GeneratePricesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShelfsStatisticsRequest GenerateShelfsStatisticsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShowsSalesReportRequest GenerateShowsSalesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateStocksOnWarehousesReportRequest GenerateStocksOnWarehousesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-----------------------------|---------------------------------| |По дате начисления услуги |dateFrom и dateTo | |По дате формирования акта |year и month |

Заказать отчеты обоих типов одним запросом нельзя.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedMarketplaceServicesReportRequest GenerateUnitedMarketplaceServicesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-------------------------|---------------------------------------| |О платежах за период |dateFrom и dateTo | |О платежном поручении |bankOrderId и bankOrderDateTime |

Заказать отчеты обоих типов одним запросом нельзя.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedNettingReportRequest GenerateUnitedNettingReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)

Запускает генерацию отчета по заказам за заданный период. Что это за отчет

{% note info "" %}

Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам

{% endnote %}

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedOrdersRequest GenerateUnitedOrdersRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter

Номер сегмента с результатами.

Значение по умолчанию: 0.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.

{% endnote %}

default: null format: int32

Return type

GetAllOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetAllOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)

Возвращает значения ставок для заданных товаров.

{% note warning "" %}

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsInfoRequest GetBidsInfoRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetBidsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "bids" : [ {
      "sku" : "sku",
      "bid" : 570
    }, {
      "sku" : "sku",
      "bid" : 570
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки. GetBidsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsRecommendationsRequest GetBidsRecommendationsRequest (required)
Body Parameter

Return type

GetBidsRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "recommendations" : [ {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    }, {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Рекомендованные ставки для заданных товаров. GetBidsRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetBusinessSettingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "settings" : {
      "currency" : "RUR",
      "onlyDefaultPrice" : true
    },
    "info" : {
      "name" : "name",
      "id" : 0
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки кабинета. GetBusinessSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignResponse

Example data

Content-Type: application/json
{
  "campaign" : {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазине. GetCampaignResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignLoginsResponse

Example data

Content-Type: application/json
{
  "logins" : [ "logins", "logins" ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список логинов, связанных с магазином. GetCampaignLoginsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCampaignOffersRequest GetCampaignOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    }, {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, размещенных в заданном магазине. GetCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)

{% note warning "" %}

Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.

{% endnote %}

Возвращает регион, в котором находится магазин. |⚙️ Лимит: 5 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignRegionResponse

Example data

Content-Type: application/json
{
  "region" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращает регион, в котором находится магазин.

|⚙️ Лимит: 1000 запросов в час| |-|

GetCampaignRegionResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignSettingsResponse

Example data

Content-Type: application/json
{
  "settings" : {
    "showInPremium" : true,
    "showInContext" : true,
    "localRegion" : {
      "delivery" : {
        "schedule" : {
          "customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
          "period" : {
            "fromDate" : "23-09-2022",
            "toDate" : "23-09-2022"
          },
          "customHolidays" : [ "23-09-2022", "23-09-2022" ],
          "weeklyHolidays" : [ 1, 1 ],
          "availableOnHolidays" : true,
          "totalHolidays" : [ "23-09-2022", "23-09-2022" ]
        }
      },
      "name" : "name",
      "id" : 6,
      "type" : "OTHER",
      "deliveryOptionsSource" : "WEB"
    },
    "countryRegion" : 0,
    "shopName" : "shopName",
    "useOpenStat" : true
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки магазина. GetCampaignSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |⚙️ Лимит: 1000 запросов в час| |-|

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Магазины пользователя. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

login (required)
Path Parameter — Логин пользователя. default: null

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазинах. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)

Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.

Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.

Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesMaxSaleQuantumRequest GetCategoriesMaxSaleQuantumRequest (required)
Body Parameter

Return type

GetCategoriesMaxSaleQuantumResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  }, {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  } ],
  "errors" : [ {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  }, {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Лимит на установку кванта и минимального количества товаров. GetCategoriesMaxSaleQuantumResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/tree
Дерево категорий (getCategoriesTree)

Возвращает дерево категорий Маркета.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesRequest GetCategoriesRequest (optional)
Body Parameter

Return type

GetCategoriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Категории Маркета. GetCategoriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)

Возвращает список характеристик с допустимыми значениями для заданной категории.

|⚙️ Лимит: 50 категорий в минуту | |-|

Path parameters

categoryId (required)
Path Parameter

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

default: null format: int64

Return type

GetCategoryContentParametersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parameters" : [ {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    }, {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    } ],
    "categoryId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список характеристик товаров из заданной категории. GetCategoryContentParametersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)

Возвращает историю сообщений в чате с покупателем.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatHistoryRequest GetChatHistoryRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatHistoryResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderId" : 0,
    "messages" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

История сообщений успешно получена. GetChatHistoryResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)

Возвращает ваши чаты с покупателями.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatsRequest GetChatsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chats" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список чатов. GetChatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования. |⚙️ Лимит: 5 000 запросов в час| |-|

Return type

GetDeliveryServicesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : [ {
      "name" : "name",
      "id" : 0
    }, {
      "name" : "name",
      "id" : 0
    } ]
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о службах доставки. GetDeliveryServicesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

GetFeedResponse

Example data

Content-Type: application/json
{
  "feed" : {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о прайс-листе. GetFeedResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Query parameters

limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

default: null format: date-time
published_time_to (optional)
Query Parameter

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

{% endnote %}

default: null format: date-time
status (optional)
Query Parameter

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.
default: null

Return type

GetFeedIndexLogsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feed" : {
      "id" : 0
    },
    "total" : 2,
    "indexLogRecords" : [ {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    }, {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по индексации прайс-листа. GetFeedIndexLogsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает новые и обновленные отзывы о магазине на Маркете.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.

|⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter

Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: ГГГГ-ММ-ДД.

default: null format: date

Return type

GetFeedbackListResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "feedbackList" : [ {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    }, {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов для магазина. GetFeedbackListResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetFeedsResponse

Example data

Content-Type: application/json
{
  "feeds" : [ {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }, {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список прайс-листов. GetFeedsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)

Возвращает комментарии к отзыву.

Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackCommentsRequest GetGoodsFeedbackCommentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackCommentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "comments" : [ {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    }, {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Дерево комментариев к отзыву. GetGoodsFeedbackCommentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)

Возвращает все отзывы о товарах продавца по указанным фильтрам.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.

Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackRequest GetGoodsFeedbackRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feedbacks" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов. GetGoodsFeedbackResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsStatsRequest GetGoodsStatsRequest (required)
Body Parameter

Return type

GetGoodsStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "shopSkus" : [ {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по товарам. GetGoodsStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)

Возвращает список скрытых вами товаров для заданного магазина.

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

default: null format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetHiddenOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "hiddenOffers" : [ {
      "offerId" : "offerId"
    }, {
      "offerId" : "offerId"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о скрытых вами товарах. GetHiddenOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)

Возвращает сведения о состоянии контента для заданных товаров:

|⚙️ Лимит: 600 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferCardsContentStatusRequest GetOfferCardsContentStatusRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferCardsContentStatusResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerCards" : [ {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    }, {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о карточках указанных товаров. GetOfferCardsContentStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:

Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.

{% note info %}

Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter

Ваш SKU товара.

Параметр может быть указан несколько раз, например:

...shop_sku=123&shop_sku=129&shop_sku=141...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter

Фильтрация по статусу публикации товара:

  • READY — товар прошел модерацию.
  • IN_WORK — товар проходит модерацию.
  • NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
  • NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
  • REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
  • SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
  • OTHER — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
availability (optional)
Query Parameter

Фильтрация по планам поставок товара:

  • ACTIVE — поставки будут.
  • INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
  • DELISTED — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
category_id (optional)
Query Parameter

Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
vendor (optional)
Query Parameter

Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerMappingEntries" : [ {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    }, {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferMappingsRequest GetOfferMappingsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerMappings" : [ {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)

Метод возвращает рекомендации нескольких типов.

1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.

Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено

2. Оценка привлекательности цен на витрине.

Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferRecommendationsRequest GetOfferRecommendationsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerRecommendations" : [ {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    }, {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с рекомендациями. GetOfferRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.

Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

{% note info %}

Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

{% endnote %}

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

query (optional)
Query Parameter

Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

default: null
currency (optional)
Query Parameter

Валюта, в которой указана цена предложения.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

default: null
matched (optional)
Query Parameter

Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

  • 0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

  • 1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)

Возвращает информацию о заказе.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказе. GetOrderResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "organizationName" : "organizationName",
    "organizationJurAddress" : "organizationJurAddress",
    "inn" : "inn",
    "kpp" : "kpp"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetBusinessBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)

Возвращает информацию о документах по идентификатору заказа.

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessDocumentsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "sf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "torgTwelve" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "upd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ukd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ksf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о документах. GetBusinessDocumentsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderLabelsDataResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parcelBoxLabels" : [ {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    }, {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    } ],
    "orderId" : 0,
    "placesNumber" : 6,
    "url" : "url"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация для печати ярлыков. GetOrderLabelsDataResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.

Доступна фильтрация по нескольким характеристикам заказов:

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.

Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter

Статус заказа:

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
substatus (optional)
Query Parameter

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.
  • SHIPPED — заказ передан службе доставки.

Возможные значения для заказа в статусе CANCELLED:

  • DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

  • USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.

  • CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате оформления.

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.

Значение по умолчанию: 30 дней назад от текущей даты.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате оформления.

Показываются заказы, созданные до 00:00 указанного дня.

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.

Значение по умолчанию: текущая дата.

default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date
supplierShipmentDateTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date
updatedAtFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date-time
updatedAtTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter

Фильтрация заказов по типам:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

default: false
hasCis (optional)
Query Parameter

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.

  • false — нет.

Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter

Только для модели DBS

Фильтрация заказов по наличию запросов покупателей на отмену.

При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.

Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

default: false
onlyEstimatedDelivery (optional)
Query Parameter

Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:

  • true — возвращаются только заказы с неподтвержденной датой доставки.
  • false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "orders" : [ {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }, {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах. GetOrdersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

{% note info "" %}

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

{% endnote %}

В одном запросе можно получить информацию не более чем по 200 заказам.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOrdersStatsRequest GetOrdersStatsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    }, {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по заказам. GetOrdersStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.

{% endnote %}

Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.

{% note info %}

Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.

{% endnote %}

Способы установки цен описаны в Справке Маркета для продавцов.

|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false

Return type

GetPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "total" : 6,
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список всех товаров с установленными ценами. GetPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)

Возвращает список цен на указанные товары в магазине.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPricesByOfferIdsRequest GetPricesByOfferIdsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPricesByOfferIdsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с установленными для заданного магазина ценами. GetPricesByOfferIdsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)

Возвращает список товаров, которые участвуют или могут участвовать в акции.

{% note warning %}

В параметре limit не передавайте значение больше 500.

{% endnote %}

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromoOffersRequest GetPromoOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    }, {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, которые участвуют или могут участвовать в акции. GetPromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)

Возвращает информацию об акциях Маркета.

По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromosRequest GetPromosRequest (optional)
Body Parameter

Return type

GetPromosResponse

Example data

Content-Type: application/json
{
  "result" : {
    "promos" : [ {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    }, {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список акций Маркета. GetPromosResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос POST businesses/{businessId}/ratings/quality.

|⚙️ Лимит: 100000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetQualityRatingDetailsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "affectedOrders" : [ {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    }, {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах, которые повлияли на индекс качества. GetQualityRatingDetailsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQualityRatingRequest GetQualityRatingRequest (required)
Body Parameter

Return type

GetQualityRatingResponse

Example data

Content-Type: application/json
{
  "result" : {
    "campaignRatings" : [ {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    }, {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значение индекса качества магазинов и его составляющие. GetQualityRatingResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null

Return type

GetReportInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
    "file" : "file",
    "generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
    "subStatus" : "NO_DATA",
    "status" : "PENDING",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус генерации отчета и ссылка, если она уже есть.

{% note tip %}

Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.

{% endnote %}

 

GetReportInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)

Получает информацию по одному невыкупу или возврату.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

GetReturnResponse

Example data

Content-Type: application/json
{
  "result" : {
    "updateDate" : "2000-01-23T04:56:07.000+00:00",
    "fastReturn" : true,
    "orderId" : 6,
    "shipmentRecipientType" : "SHOP",
    "refundStatus" : "STARTED_BY_USER",
    "logisticPickupPoint" : {
      "logisticPartnerId" : 5,
      "address" : {
        "country" : "Россия",
        "city" : "Москва",
        "street" : "Стрелецкая улица",
        "postcode" : "123518",
        "house" : "9к2"
      },
      "instruction" : "instruction",
      "name" : "name",
      "id" : 1,
      "type" : "WAREHOUSE"
    },
    "id" : 0,
    "creationDate" : "2000-01-23T04:56:07.000+00:00",
    "items" : [ {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    }, {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    } ],
    "returnType" : "UNREDEEMED",
    "shipmentStatus" : "CREATED",
    "refundAmount" : 5
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. GetReturnResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)

Загружает заявление покупателя на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Заявление на возврат. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)

Получает фотографии, которые покупатель приложил к заявлению на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Фотография возврата. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

default: null format: int64
statuses (optional)
Query Parameter

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

default: null
type (optional)
Query Parameter

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
from_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте fromDate.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date
to_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте toDate.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date

Return type

GetReturnsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "returns" : [ {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    }, {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Постраничные возвраты партнера. GetReturnsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)

Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).

{% note info "По умолчанию данные по оборачивамости не возращаются" %}

Чтобы они были в ответе, передавайте true в поле withTurnover.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetWarehouseStocksRequest GetWarehouseStocksRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetWarehouseStocksResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    }, {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Остатки товаров на складах. GetWarehouseStocksResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.

{% endnote %}

Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.

Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:

##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##

Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.

Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.

В одном запросе можно получить не более 500 рекомендаций.

|⚙️ Лимит: 100 000 рекомендаций в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingEntriesRequest GetSuggestedOfferMappingEntriesRequest (required)
Body Parameter

Return type

GetSuggestedOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    }, {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetSuggestedOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

{% endnote %}

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingsRequest GetSuggestedOfferMappingsRequest (optional)
Body Parameter

Return type

GetSuggestedOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

GetSuggestedOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте отчет «Цены на рынке».

{% endnote %}

{% note warning "" %}

Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.

{% endnote %}

Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.

Товары, для которых нужно получить цены, передаются в теле POST-запроса.

Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.

Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.

Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.

Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SuggestPricesRequest SuggestPricesRequest (required)
Body Parameter

Return type

SuggestPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    }, {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список цен для продвижения на Маркете. SuggestPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)

Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны

Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    } ],
    "warehouseGroups" : [ {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    }, {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов и групп складов. GetWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Передает Маркету коды маркировки для единиц товара в указанном заказе.

Принимаются коды следующих типов:

{% note warning %}

Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.

{% endnote %}

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderItemIdentifiersRequest ProvideOrderItemIdentifiersRequest (required)
Body Parameter

Return type

ProvideOrderItemIdentifiersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "items" : [ {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    }, {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах. ProvideOrderItemIdentifiersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

{% cut "Как в кабинете выглядит кампания, созданная через API" %}

{% endcut %}

При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

  1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
  2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh.
  3. Маркет начинает обновление данных магазина на сервисе.

{% note alert %}

Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

{% endnote %}

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetRegionWithChildrenResponse

Example data

Content-Type: application/json
{
  "regions" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  },
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Регионы, являющиеся дочерними к указанному в запросе. GetRegionWithChildrenResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)

Возвращает информацию о регионе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденный регион. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions
Поиск регионов по их имени (searchRegionsByName)

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Query parameters

name (required)
Query Parameter

Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список найденных регионов. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)

Отправляет файл в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Form parameters

file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что файл отправлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)

Отправляет сообщение в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SendMessageToChatRequest SendMessageToChatRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что сообщение отправлено. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetFeedParamsRequest SetFeedParamsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)

{% note tip "Подходит и для DBS" %}

Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.

{% endnote %}

Позволяет выполнить три операции:

Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.

Как передать информацию о распределении товаров

В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:

⚠️ Одна коробка не может содержать и товары целиком, и части товаров.

Как передавать коды маркировки

Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?

Принимаются коды следующих типов:

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.

Как удалить товар из заказа

Чтобы удалить товар из заказа:

  1. Добавьте в запрос allowRemove: true.
  2. Передайте распределение по коробкам без товара, который нужно удалить.

{% note warning "Удаление нельзя отменить" %}

Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.

{% endnote %}

Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.

Нельзя удалить или уменьшить количество товара, если он:

Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Примеры

{% cut "Товар умещается в коробку" %}

Вот как будет выглядеть запрос, если в одной коробке едут:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "fullCount": 3,
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        },
                        {
                            "cis": "010304109478gftJ14545762!\u001dhGt264"
                        },
                        {
                            "cis": "010304109478fRs28323ks23!\u001dhet201"
                        }
                    ]
                },
                {
                    "id": 654321,
                    "fullCount": 1
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Товар едет в разных коробках" %}

Вот как будет выглядеть запрос, если товар едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}

Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderBoxLayoutRequest SetOrderBoxLayoutRequest (required)
Body Parameter

Return type

SetOrderBoxLayoutResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    }, {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков. SetOrderBoxLayoutResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.

Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.

Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.

Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.

{% cut "Как было раньше" %}

Структура тела PUT-запроса:

{
  "boxes":
  [
    {
      "fulfilmentId": "{string}",
      "weight": {int64},
      "width": {int64},
      "height": {int64},
      "depth": {int64},
      "items":
      [
        {
          "id": {int64},
          "count": {int32}
        },
        ...
      ]
    },
    ...
  ]
}

| Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | boxes | | Список грузовых мест. |

Параметры, вложенные в boxes | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. | | weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | width | Int64 | Ширина грузового места в сантиметрах. | | height | Int64 | Высота грузового места в сантиметрах. | | depth | Int64 | Глубина грузового места в сантиметрах. | | items | Int64 | Список товаров в грузовом месте. |

Параметры, вложенные в items | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | id | Int64 | Идентификатор товара в рамках заказа. | | count | Int32 | Количество единиц товара в грузовом месте. |

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderShipmentBoxesRequest SetOrderShipmentBoxesRequest (required)
Body Parameter

Return type

SetOrderShipmentBoxesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    }, {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество грузомест записано. SetOrderShipmentBoxesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов POST businesses/{businessId}/goods-feedback.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SkipGoodsFeedbackReactionRequest SkipGoodsFeedbackReactionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)

Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateBusinessPricesRequest UpdateBusinessPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateCampaignOffersRequest UpdateCampaignOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.

Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.

Чтобы добавить комментарий к другому комментарию, передайте:

Чтобы изменить комментарий, передайте:

Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateGoodsFeedbackCommentRequest UpdateGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

UpdateGoodsFeedbackCommentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "author" : {
      "name" : "name",
      "type" : "USER"
    },
    "id" : 0,
    "text" : "text",
    "canModify" : true,
    "parentId" : 6,
    "status" : "PUBLISHED"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о добавленном или измененном комментарии. UpdateGoodsFeedbackCommentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)

Редактирует характеристики товара, которые специфичны для категории, к которой он относится.

{% note warning "Здесь только то, что относится к конкретной категории" %}

Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferContentRequest UpdateOfferContentRequest (required)
Body Parameter

Return type

UpdateOfferContentResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос выполнен корректно, данные обработаны.

{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

{% endnote %}

Если в status вернулось ERROR, убедитесь, что:

Найти проблемы помогут поля errors и warnings.

UpdateOfferContentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.

Информацию о товарах нужно передать в теле POST-запроса.

У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:

В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.

Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

В одном запросе можно добавить не более 500 товаров.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingEntryRequest UpdateOfferMappingEntryRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.

Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

{% note warning "Правила использования SKU" %}

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingsRequest UpdateOfferMappingsRequest (required)
Body Parameter

Return type

UpdateOfferMappingsResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге. UpdateOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:

Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.

Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.

Чтобы полностью удалить товар из заказа:

Нельзя удалить или уменьшить количество товара, если он:

Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Возврат денег покупателю

Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderItemRequest UpdateOrderItemRequest (required)
Body Parameter

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)

Изменяет статус заказа. Возможные изменения статусов:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusRequest UpdateOrderStatusRequest (required)
Body Parameter

Return type

UpdateOrderStatusResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В случае успешного изменения статуса заказа возвращается обновленная информация о заказе. UpdateOrderStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)

Изменяет статусы нескольких заказов.

Возможные изменения статусов:

Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusesRequest UpdateOrderStatusesRequest (required)
Body Parameter

Return type

UpdateOrderStatusesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    }, {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращается информация об обновленных статусах заказов. UpdateOrderStatusesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePricesRequest UpdatePricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePromoOffersRequest UpdatePromoOffersRequest (required)
Body Parameter

Return type

UpdatePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ],
    "warningOffers" : [ {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    }, {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат добавления товаров в акцию или обновления их цен. UpdatePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)

Передает данные об остатках товаров на витрине.

Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateStocksRequest UpdateStocksRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/verifyEac
Передача кода подтверждения (verifyOrderEac)

Отправляет Маркету код подтверждения для его проверки.

Код подтверждает передачу заказа или невыкупа:

Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения.

Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа.

Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину.

Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VerifyOrderEacRequest VerifyOrderEacRequest (required)
Body Parameter

Return type

VerifyOrderEacResponse

Example data

Content-Type: application/json
{
  "result" : {
    "verificationResult" : "ACCEPTED",
    "attemptsLeft" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Проверка кода выполнена успешно. VerifyOrderEacResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Fbs

Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)

Скрывает товары магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddHiddenOffersRequest AddHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки скрытия получены и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.

{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}

Вначале такой товар нужно распродать или вывезти.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddOffersToArchiveRequest AddOffersToArchiveRequest (required)
Body Parameter

Return type

AddOffersToArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notArchivedOffers" : [ {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    }, {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.

Список успешно добавленных товаров не возвращается.

AddOffersToArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

|⚙️ Лимит: 100 запросов в минуту| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CalculateTariffsRequest CalculateTariffsRequest (required)
Body Parameter

Return type

CalculateTariffsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Стоимость услуг. CalculateTariffsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.

Основная цена задается в каталоге и действует во всех магазинах кабинета.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm
Подтверждение отгрузки (confirmShipment)
Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmShipmentRequest ConfirmShipmentRequest (optional)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)

Создает новый чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateChatRequest CreateChatRequest (required)
Body Parameter

Return type

CreateChatResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chatId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: чат создан. CreateChatResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)

Удаляет заданные товары из заданного магазина.

{% note warning "Запрос удаляет товары именно из конкретного магазина" %}

На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.

{% endnote %}

Товар не получится удалить, если он хранится на складах Маркета.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteCampaignOffersRequest DeleteCampaignOffersRequest (required)
Body Parameter

Return type

DeleteCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)

Удаляет комментарий магазина.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteGoodsFeedbackCommentRequest DeleteGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)

Возобновляет показ скрытых вами товаров магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteHiddenOffersRequest DeleteHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Показ товаров возобновлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)

Удаляет товары из каталога.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersRequest DeleteOffersRequest (required)
Body Parameter

Return type

DeleteOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)

Восстанавливает товары из архива.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersFromArchiveRequest DeleteOffersFromArchiveRequest (required)
Body Parameter

Return type

DeleteOffersFromArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notUnarchivedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.

Список успешно восстановленных товаров не возвращается.

DeleteOffersFromArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)

Убирает товары из акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeletePromoOffersRequest DeletePromoOffersRequest (required)
Body Parameter

Return type

DeletePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат удаления товаров из акции. DeletePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act
Получение акта приема-передачи (downloadShipmentAct)

{% note warning "Экспресс‑доставка" %}

Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.

{% endnote %}

Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы.

При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:

{% cut "Данные, из которых Маркет формирует акт" %}

| Данные в акте | Описание | | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Дата | Дата запроса. | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |

{% endcut %}

Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт приема-передачи для отгрузки в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act
Получение акта расхождений (downloadShipmentDiscrepancyAct)
Возвращает акт расхождений для заданной отгрузки. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт расхождений в формате XLSX. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act
Получение фактического акта приема-передачи (downloadShipmentInboundAct)

Возвращает фактический акт приема-передачи для заданной отгрузки.

Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения.

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels
Ярлыки для доверительной приемки (FBS) (downloadShipmentPalletLabels)

PDF-файл с ярлыками на каждый короб или палету в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета.

Распечатайте по несколько копий каждого ярлыка: на одну тару нужно наклеить минимум 2 ярлыка с разных сторон.

Количество упаковок в отгрузке задается в запросе PUT campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Query parameters

format (optional)
Query Parameter

Формат страниц PDF-файла с ярлыками:

  • A4 — по 16 ярлыков на странице.
  • A8 — по одному ярлыку на странице.
default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все упаковки в отгрузке. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/shipments/reception-transfer-act
Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее (downloadShipmentReceptionTransferAct)

Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF.

{% note warning "Экспресс‑доставка" %}

Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.

{% endnote %}

В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета.

При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:

{% cut "Данные, из которых Маркет формирует акт" %}

| Данные в акте | Описание | | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |

{% endcut %}

Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

warehouse_id (optional)
Query Parameter — Идентификатор склада. default: null format: int32

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт приема-передачи в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill
Получение транспортной накладной (downloadShipmentTransportationWaybill)

Возвращает транспортную накладную для заданной отгрузки.

Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. Подробно об этом способе отгрузки

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Транспортная накладная в формате XLSX. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)

Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateBoostConsolidatedRequest GenerateBoostConsolidatedRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)

Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

{% note info "Значение -1 в отчете" %}

Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.

{% endnote %}

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateCompetitorsPositionReportRequest GenerateCompetitorsPositionReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)

Запускает генерацию отчета по отзывам о товарах. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsFeedbackRequest GenerateGoodsFeedbackRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)

Запускает генерацию отчета по реализации за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsRealizationReportRequest GenerateGoodsRealizationReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 1000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateMassOrderLabelsRequest GenerateMassOrderLabelsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все коробки. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)

Запускает генерацию отчета «Цены на рынке».

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GeneratePricesReportRequest GeneratePricesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShelfsStatisticsRequest GenerateShelfsStatisticsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/shipment-list/generate
Получение листа сборки (generateShipmentListDocumentReport)

Запускает генерацию листа сборки для отгрузки.

Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShipmentListDocumentReportRequest GenerateShipmentListDocumentReportRequest (required)
Body Parameter

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый документ. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShowsSalesReportRequest GenerateShowsSalesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateStocksOnWarehousesReportRequest GenerateStocksOnWarehousesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-----------------------------|---------------------------------| |По дате начисления услуги |dateFrom и dateTo | |По дате формирования акта |year и month |

Заказать отчеты обоих типов одним запросом нельзя.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedMarketplaceServicesReportRequest GenerateUnitedMarketplaceServicesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-------------------------|---------------------------------------| |О платежах за период |dateFrom и dateTo | |О платежном поручении |bankOrderId и bankOrderDateTime |

Заказать отчеты обоих типов одним запросом нельзя.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedNettingReportRequest GenerateUnitedNettingReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)

Запускает генерацию отчета по заказам за заданный период. Что это за отчет

{% note info "" %}

Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам

{% endnote %}

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedOrdersRequest GenerateUnitedOrdersRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter

Номер сегмента с результатами.

Значение по умолчанию: 0.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.

{% endnote %}

default: null format: int32

Return type

GetAllOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetAllOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)

Возвращает значения ставок для заданных товаров.

{% note warning "" %}

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsInfoRequest GetBidsInfoRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetBidsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "bids" : [ {
      "sku" : "sku",
      "bid" : 570
    }, {
      "sku" : "sku",
      "bid" : 570
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки. GetBidsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsRecommendationsRequest GetBidsRecommendationsRequest (required)
Body Parameter

Return type

GetBidsRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "recommendations" : [ {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    }, {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Рекомендованные ставки для заданных товаров. GetBidsRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetBusinessSettingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "settings" : {
      "currency" : "RUR",
      "onlyDefaultPrice" : true
    },
    "info" : {
      "name" : "name",
      "id" : 0
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки кабинета. GetBusinessSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignResponse

Example data

Content-Type: application/json
{
  "campaign" : {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазине. GetCampaignResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignLoginsResponse

Example data

Content-Type: application/json
{
  "logins" : [ "logins", "logins" ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список логинов, связанных с магазином. GetCampaignLoginsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCampaignOffersRequest GetCampaignOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    }, {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, размещенных в заданном магазине. GetCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)

{% note warning "" %}

Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.

{% endnote %}

Возвращает регион, в котором находится магазин. |⚙️ Лимит: 5 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignRegionResponse

Example data

Content-Type: application/json
{
  "region" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращает регион, в котором находится магазин.

|⚙️ Лимит: 1000 запросов в час| |-|

GetCampaignRegionResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignSettingsResponse

Example data

Content-Type: application/json
{
  "settings" : {
    "showInPremium" : true,
    "showInContext" : true,
    "localRegion" : {
      "delivery" : {
        "schedule" : {
          "customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
          "period" : {
            "fromDate" : "23-09-2022",
            "toDate" : "23-09-2022"
          },
          "customHolidays" : [ "23-09-2022", "23-09-2022" ],
          "weeklyHolidays" : [ 1, 1 ],
          "availableOnHolidays" : true,
          "totalHolidays" : [ "23-09-2022", "23-09-2022" ]
        }
      },
      "name" : "name",
      "id" : 6,
      "type" : "OTHER",
      "deliveryOptionsSource" : "WEB"
    },
    "countryRegion" : 0,
    "shopName" : "shopName",
    "useOpenStat" : true
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки магазина. GetCampaignSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |⚙️ Лимит: 1000 запросов в час| |-|

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Магазины пользователя. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

login (required)
Path Parameter — Логин пользователя. default: null

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазинах. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)

Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.

Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.

Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesMaxSaleQuantumRequest GetCategoriesMaxSaleQuantumRequest (required)
Body Parameter

Return type

GetCategoriesMaxSaleQuantumResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  }, {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  } ],
  "errors" : [ {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  }, {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Лимит на установку кванта и минимального количества товаров. GetCategoriesMaxSaleQuantumResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/tree
Дерево категорий (getCategoriesTree)

Возвращает дерево категорий Маркета.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesRequest GetCategoriesRequest (optional)
Body Parameter

Return type

GetCategoriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Категории Маркета. GetCategoriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)

Возвращает список характеристик с допустимыми значениями для заданной категории.

|⚙️ Лимит: 50 категорий в минуту | |-|

Path parameters

categoryId (required)
Path Parameter

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

default: null format: int64

Return type

GetCategoryContentParametersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parameters" : [ {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    }, {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    } ],
    "categoryId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список характеристик товаров из заданной категории. GetCategoryContentParametersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)

Возвращает историю сообщений в чате с покупателем.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatHistoryRequest GetChatHistoryRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatHistoryResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderId" : 0,
    "messages" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

История сообщений успешно получена. GetChatHistoryResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)

Возвращает ваши чаты с покупателями.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatsRequest GetChatsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chats" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список чатов. GetChatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования. |⚙️ Лимит: 5 000 запросов в час| |-|

Return type

GetDeliveryServicesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : [ {
      "name" : "name",
      "id" : 0
    }, {
      "name" : "name",
      "id" : 0
    } ]
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о службах доставки. GetDeliveryServicesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

GetFeedResponse

Example data

Content-Type: application/json
{
  "feed" : {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о прайс-листе. GetFeedResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Query parameters

limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

default: null format: date-time
published_time_to (optional)
Query Parameter

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

{% endnote %}

default: null format: date-time
status (optional)
Query Parameter

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.
default: null

Return type

GetFeedIndexLogsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feed" : {
      "id" : 0
    },
    "total" : 2,
    "indexLogRecords" : [ {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    }, {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по индексации прайс-листа. GetFeedIndexLogsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает новые и обновленные отзывы о магазине на Маркете.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.

|⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter

Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: ГГГГ-ММ-ДД.

default: null format: date

Return type

GetFeedbackListResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "feedbackList" : [ {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    }, {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов для магазина. GetFeedbackListResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetFeedsResponse

Example data

Content-Type: application/json
{
  "feeds" : [ {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }, {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список прайс-листов. GetFeedsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)

Возвращает комментарии к отзыву.

Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackCommentsRequest GetGoodsFeedbackCommentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackCommentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "comments" : [ {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    }, {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Дерево комментариев к отзыву. GetGoodsFeedbackCommentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)

Возвращает все отзывы о товарах продавца по указанным фильтрам.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.

Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackRequest GetGoodsFeedbackRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feedbacks" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов. GetGoodsFeedbackResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsStatsRequest GetGoodsStatsRequest (required)
Body Parameter

Return type

GetGoodsStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "shopSkus" : [ {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по товарам. GetGoodsStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)

Возвращает список скрытых вами товаров для заданного магазина.

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

default: null format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetHiddenOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "hiddenOffers" : [ {
      "offerId" : "offerId"
    }, {
      "offerId" : "offerId"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о скрытых вами товарах. GetHiddenOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)

Возвращает сведения о состоянии контента для заданных товаров:

|⚙️ Лимит: 600 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferCardsContentStatusRequest GetOfferCardsContentStatusRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferCardsContentStatusResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerCards" : [ {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    }, {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о карточках указанных товаров. GetOfferCardsContentStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:

Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.

{% note info %}

Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter

Ваш SKU товара.

Параметр может быть указан несколько раз, например:

...shop_sku=123&shop_sku=129&shop_sku=141...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter

Фильтрация по статусу публикации товара:

  • READY — товар прошел модерацию.
  • IN_WORK — товар проходит модерацию.
  • NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
  • NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
  • REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
  • SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
  • OTHER — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
availability (optional)
Query Parameter

Фильтрация по планам поставок товара:

  • ACTIVE — поставки будут.
  • INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
  • DELISTED — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
category_id (optional)
Query Parameter

Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
vendor (optional)
Query Parameter

Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerMappingEntries" : [ {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    }, {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferMappingsRequest GetOfferMappingsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerMappings" : [ {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)

Метод возвращает рекомендации нескольких типов.

1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.

Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено

2. Оценка привлекательности цен на витрине.

Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferRecommendationsRequest GetOfferRecommendationsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerRecommendations" : [ {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    }, {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с рекомендациями. GetOfferRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.

Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

{% note info %}

Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

{% endnote %}

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

query (optional)
Query Parameter

Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

default: null
currency (optional)
Query Parameter

Валюта, в которой указана цена предложения.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

default: null
matched (optional)
Query Parameter

Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

  • 0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

  • 1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)

Возвращает информацию о заказе.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказе. GetOrderResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "organizationName" : "organizationName",
    "organizationJurAddress" : "organizationJurAddress",
    "inn" : "inn",
    "kpp" : "kpp"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetBusinessBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)

Возвращает информацию о документах по идентификатору заказа.

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessDocumentsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "sf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "torgTwelve" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "upd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ukd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ksf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о документах. GetBusinessDocumentsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderLabelsDataResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parcelBoxLabels" : [ {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    }, {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    } ],
    "orderId" : 0,
    "placesNumber" : 6,
    "url" : "url"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация для печати ярлыков. GetOrderLabelsDataResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.

Доступна фильтрация по нескольким характеристикам заказов:

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.

Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter

Статус заказа:

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
substatus (optional)
Query Parameter

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.
  • SHIPPED — заказ передан службе доставки.

Возможные значения для заказа в статусе CANCELLED:

  • DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

  • USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.

  • CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате оформления.

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.

Значение по умолчанию: 30 дней назад от текущей даты.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате оформления.

Показываются заказы, созданные до 00:00 указанного дня.

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.

Значение по умолчанию: текущая дата.

default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date
supplierShipmentDateTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date
updatedAtFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date-time
updatedAtTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter

Фильтрация заказов по типам:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

default: false
hasCis (optional)
Query Parameter

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.

  • false — нет.

Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter

Только для модели DBS

Фильтрация заказов по наличию запросов покупателей на отмену.

При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.

Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

default: false
onlyEstimatedDelivery (optional)
Query Parameter

Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:

  • true — возвращаются только заказы с неподтвержденной датой доставки.
  • false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "orders" : [ {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }, {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах. GetOrdersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

{% note info "" %}

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

{% endnote %}

В одном запросе можно получить информацию не более чем по 200 заказам.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOrdersStatsRequest GetOrdersStatsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    }, {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по заказам. GetOrdersStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.

{% endnote %}

Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.

{% note info %}

Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.

{% endnote %}

Способы установки цен описаны в Справке Маркета для продавцов.

|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false

Return type

GetPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "total" : 6,
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список всех товаров с установленными ценами. GetPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)

Возвращает список цен на указанные товары в магазине.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPricesByOfferIdsRequest GetPricesByOfferIdsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPricesByOfferIdsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с установленными для заданного магазина ценами. GetPricesByOfferIdsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)

Возвращает список товаров, которые участвуют или могут участвовать в акции.

{% note warning %}

В параметре limit не передавайте значение больше 500.

{% endnote %}

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromoOffersRequest GetPromoOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    }, {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, которые участвуют или могут участвовать в акции. GetPromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)

Возвращает информацию об акциях Маркета.

По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromosRequest GetPromosRequest (optional)
Body Parameter

Return type

GetPromosResponse

Example data

Content-Type: application/json
{
  "result" : {
    "promos" : [ {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    }, {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список акций Маркета. GetPromosResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос POST businesses/{businessId}/ratings/quality.

|⚙️ Лимит: 100000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetQualityRatingDetailsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "affectedOrders" : [ {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    }, {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах, которые повлияли на индекс качества. GetQualityRatingDetailsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQualityRatingRequest GetQualityRatingRequest (required)
Body Parameter

Return type

GetQualityRatingResponse

Example data

Content-Type: application/json
{
  "result" : {
    "campaignRatings" : [ {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    }, {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значение индекса качества магазинов и его составляющие. GetQualityRatingResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null

Return type

GetReportInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
    "file" : "file",
    "generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
    "subStatus" : "NO_DATA",
    "status" : "PENDING",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус генерации отчета и ссылка, если она уже есть.

{% note tip %}

Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.

{% endnote %}

 

GetReportInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)

Получает информацию по одному невыкупу или возврату.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

GetReturnResponse

Example data

Content-Type: application/json
{
  "result" : {
    "updateDate" : "2000-01-23T04:56:07.000+00:00",
    "fastReturn" : true,
    "orderId" : 6,
    "shipmentRecipientType" : "SHOP",
    "refundStatus" : "STARTED_BY_USER",
    "logisticPickupPoint" : {
      "logisticPartnerId" : 5,
      "address" : {
        "country" : "Россия",
        "city" : "Москва",
        "street" : "Стрелецкая улица",
        "postcode" : "123518",
        "house" : "9к2"
      },
      "instruction" : "instruction",
      "name" : "name",
      "id" : 1,
      "type" : "WAREHOUSE"
    },
    "id" : 0,
    "creationDate" : "2000-01-23T04:56:07.000+00:00",
    "items" : [ {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    }, {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    } ],
    "returnType" : "UNREDEEMED",
    "shipmentStatus" : "CREATED",
    "refundAmount" : 5
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. GetReturnResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)

Загружает заявление покупателя на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Заявление на возврат. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)

Получает фотографии, которые покупатель приложил к заявлению на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Фотография возврата. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

default: null format: int64
statuses (optional)
Query Parameter

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

default: null
type (optional)
Query Parameter

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
from_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте fromDate.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date
to_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте toDate.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date

Return type

GetReturnsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "returns" : [ {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    }, {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Постраничные возвраты партнера. GetReturnsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Получение информации об одной отгрузке (getShipment)
Возвращает информацию об отгрузке по ее идентификатору. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Query parameters

cancelledOrders (optional)
Query Parameter

Возвращать ли отмененные заказы.

Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.

default: true

Return type

GetShipmentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : {
      "name" : "name",
      "id" : 1
    },
    "availableActions" : [ "CONFIRM", "CONFIRM" ],
    "draftCount" : 7,
    "plannedCount" : 9,
    "currentStatus" : {
      "description" : "description",
      "updateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    },
    "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
    "externalId" : "externalId",
    "warehouse" : {
      "address" : "address",
      "name" : "name",
      "id" : 6
    },
    "shipmentType" : "IMPORT",
    "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
    "warehouseTo" : {
      "address" : "address",
      "name" : "name",
      "id" : 6
    },
    "factCount" : 3,
    "palletsCount" : {
      "fact" : 5,
      "planned" : 5
    },
    "id" : 0,
    "orderIds" : [ 2, 2 ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденная отгрузка. GetShipmentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info
Получение информации о возможности печати ярлыков (FBS) (getShipmentOrdersInfo)
Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

GetShipmentOrdersInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderIdsWithLabels" : [ 0, 0 ],
    "orderIdsWithoutLabels" : [ 6, 6 ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по годным/негодным для печати ярлыков заказам в отгрузке. GetShipmentOrdersInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)

Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).

{% note info "По умолчанию данные по оборачивамости не возращаются" %}

Чтобы они были в ответе, передавайте true в поле withTurnover.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetWarehouseStocksRequest GetWarehouseStocksRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetWarehouseStocksResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    }, {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Остатки товаров на складах. GetWarehouseStocksResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.

{% endnote %}

Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.

Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:

##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##

Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.

Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.

В одном запросе можно получить не более 500 рекомендаций.

|⚙️ Лимит: 100 000 рекомендаций в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingEntriesRequest GetSuggestedOfferMappingEntriesRequest (required)
Body Parameter

Return type

GetSuggestedOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    }, {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetSuggestedOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

{% endnote %}

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingsRequest GetSuggestedOfferMappingsRequest (optional)
Body Parameter

Return type

GetSuggestedOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

GetSuggestedOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте отчет «Цены на рынке».

{% endnote %}

{% note warning "" %}

Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.

{% endnote %}

Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.

Товары, для которых нужно получить цены, передаются в теле POST-запроса.

Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.

Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.

Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.

Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SuggestPricesRequest SuggestPricesRequest (required)
Body Parameter

Return type

SuggestPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    }, {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список цен для продвижения на Маркете. SuggestPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)

Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны

Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    } ],
    "warehouseGroups" : [ {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    }, {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов и групп складов. GetWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Передает Маркету коды маркировки для единиц товара в указанном заказе.

Принимаются коды следующих типов:

{% note warning %}

Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.

{% endnote %}

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderItemIdentifiersRequest ProvideOrderItemIdentifiersRequest (required)
Body Parameter

Return type

ProvideOrderItemIdentifiersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "items" : [ {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    }, {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах. ProvideOrderItemIdentifiersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

{% cut "Как в кабинете выглядит кампания, созданная через API" %}

{% endcut %}

При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

  1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
  2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh.
  3. Маркет начинает обновление данных магазина на сервисе.

{% note alert %}

Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

{% endnote %}

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetRegionWithChildrenResponse

Example data

Content-Type: application/json
{
  "regions" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  },
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Регионы, являющиеся дочерними к указанному в запросе. GetRegionWithChildrenResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)

Возвращает информацию о регионе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденный регион. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions
Поиск регионов по их имени (searchRegionsByName)

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Query parameters

name (required)
Query Parameter

Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список найденных регионов. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/first-mile/shipments
Получение информации о нескольких отгрузках (searchShipments)

Возвращает информацию об отгрузках по заданным параметрам:

Результаты возвращаются постранично. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchShipmentsRequest SearchShipmentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

SearchShipmentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "shipments" : [ {
      "deliveryService" : {
        "name" : "name",
        "id" : 1
      },
      "draftCount" : 1,
      "plannedCount" : 5,
      "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
      "externalId" : "externalId",
      "warehouse" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "shipmentType" : "IMPORT",
      "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
      "statusDescription" : "statusDescription",
      "warehouseTo" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "factCount" : 5,
      "palletsCount" : {
        "fact" : 5,
        "planned" : 5
      },
      "id" : 0,
      "orderIds" : [ 6, 6 ],
      "statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    }, {
      "deliveryService" : {
        "name" : "name",
        "id" : 1
      },
      "draftCount" : 1,
      "plannedCount" : 5,
      "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
      "externalId" : "externalId",
      "warehouse" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "shipmentType" : "IMPORT",
      "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
      "statusDescription" : "statusDescription",
      "warehouseTo" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "factCount" : 5,
      "palletsCount" : {
        "fact" : 5,
        "planned" : 5
      },
      "id" : 0,
      "orderIds" : [ 6, 6 ],
      "statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденные отгрузки. SearchShipmentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)

Отправляет файл в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Form parameters

file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что файл отправлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)

Отправляет сообщение в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SendMessageToChatRequest SendMessageToChatRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что сообщение отправлено. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetFeedParamsRequest SetFeedParamsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)

{% note tip "Подходит и для DBS" %}

Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.

{% endnote %}

Позволяет выполнить три операции:

Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.

Как передать информацию о распределении товаров

В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:

⚠️ Одна коробка не может содержать и товары целиком, и части товаров.

Как передавать коды маркировки

Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?

Принимаются коды следующих типов:

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.

Как удалить товар из заказа

Чтобы удалить товар из заказа:

  1. Добавьте в запрос allowRemove: true.
  2. Передайте распределение по коробкам без товара, который нужно удалить.

{% note warning "Удаление нельзя отменить" %}

Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.

{% endnote %}

Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.

Нельзя удалить или уменьшить количество товара, если он:

Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Примеры

{% cut "Товар умещается в коробку" %}

Вот как будет выглядеть запрос, если в одной коробке едут:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "fullCount": 3,
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        },
                        {
                            "cis": "010304109478gftJ14545762!\u001dhGt264"
                        },
                        {
                            "cis": "010304109478fRs28323ks23!\u001dhet201"
                        }
                    ]
                },
                {
                    "id": 654321,
                    "fullCount": 1
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Товар едет в разных коробках" %}

Вот как будет выглядеть запрос, если товар едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}

Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderBoxLayoutRequest SetOrderBoxLayoutRequest (required)
Body Parameter

Return type

SetOrderBoxLayoutResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    }, {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков. SetOrderBoxLayoutResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.

Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.

Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.

Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.

{% cut "Как было раньше" %}

Структура тела PUT-запроса:

{
  "boxes":
  [
    {
      "fulfilmentId": "{string}",
      "weight": {int64},
      "width": {int64},
      "height": {int64},
      "depth": {int64},
      "items":
      [
        {
          "id": {int64},
          "count": {int32}
        },
        ...
      ]
    },
    ...
  ]
}

| Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | boxes | | Список грузовых мест. |

Параметры, вложенные в boxes | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. | | weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | width | Int64 | Ширина грузового места в сантиметрах. | | height | Int64 | Высота грузового места в сантиметрах. | | depth | Int64 | Глубина грузового места в сантиметрах. | | items | Int64 | Список товаров в грузовом месте. |

Параметры, вложенные в items | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | id | Int64 | Идентификатор товара в рамках заказа. | | count | Int32 | Количество единиц товара в грузовом месте. |

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderShipmentBoxesRequest SetOrderShipmentBoxesRequest (required)
Body Parameter

Return type

SetOrderShipmentBoxesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    }, {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество грузомест записано. SetOrderShipmentBoxesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets
Передача количества упаковок в отгрузке (setShipmentPalletsCount)

Передает Маркету количество коробов или палет в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета.

Получить PDF-файл с ярлыками для упаковок можно с помощью запроса GET campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetShipmentPalletsCountRequest SetShipmentPalletsCountRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество упаковок записано. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов POST businesses/{businessId}/goods-feedback.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SkipGoodsFeedbackReactionRequest SkipGoodsFeedbackReactionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer
Перенос заказов в следующую отгрузку (transferOrdersFromShipment)

Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка?

Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя.

{% note warning "Такие переносы снижают индекс качества магазина" %}

Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения?

{% endnote %}

Переносить заказы можно, если до формирования отгрузки осталось больше получаса.

Перенос происходит не мгновенно, а занимает несколько минут.

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TransferOrdersFromShipmentRequest TransferOrdersFromShipmentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос на перенос заказов проверен и принят, и они будут перенесены спустя несколько минут. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)

Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateBusinessPricesRequest UpdateBusinessPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateCampaignOffersRequest UpdateCampaignOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.

Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.

Чтобы добавить комментарий к другому комментарию, передайте:

Чтобы изменить комментарий, передайте:

Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateGoodsFeedbackCommentRequest UpdateGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

UpdateGoodsFeedbackCommentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "author" : {
      "name" : "name",
      "type" : "USER"
    },
    "id" : 0,
    "text" : "text",
    "canModify" : true,
    "parentId" : 6,
    "status" : "PUBLISHED"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о добавленном или измененном комментарии. UpdateGoodsFeedbackCommentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)

Редактирует характеристики товара, которые специфичны для категории, к которой он относится.

{% note warning "Здесь только то, что относится к конкретной категории" %}

Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferContentRequest UpdateOfferContentRequest (required)
Body Parameter

Return type

UpdateOfferContentResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос выполнен корректно, данные обработаны.

{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

{% endnote %}

Если в status вернулось ERROR, убедитесь, что:

Найти проблемы помогут поля errors и warnings.

UpdateOfferContentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.

Информацию о товарах нужно передать в теле POST-запроса.

У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:

В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.

Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

В одном запросе можно добавить не более 500 товаров.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingEntryRequest UpdateOfferMappingEntryRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.

Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

{% note warning "Правила использования SKU" %}

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingsRequest UpdateOfferMappingsRequest (required)
Body Parameter

Return type

UpdateOfferMappingsResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге. UpdateOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:

Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.

Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.

Чтобы полностью удалить товар из заказа:

Нельзя удалить или уменьшить количество товара, если он:

Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Возврат денег покупателю

Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderItemRequest UpdateOrderItemRequest (required)
Body Parameter

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)

Изменяет статус заказа. Возможные изменения статусов:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusRequest UpdateOrderStatusRequest (required)
Body Parameter

Return type

UpdateOrderStatusResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В случае успешного изменения статуса заказа возвращается обновленная информация о заказе. UpdateOrderStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)

Изменяет статусы нескольких заказов.

Возможные изменения статусов:

Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusesRequest UpdateOrderStatusesRequest (required)
Body Parameter

Return type

UpdateOrderStatusesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    }, {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращается информация об обновленных статусах заказов. UpdateOrderStatusesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePricesRequest UpdatePricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePromoOffersRequest UpdatePromoOffersRequest (required)
Body Parameter

Return type

UpdatePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ],
    "warningOffers" : [ {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    }, {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат добавления товаров в акцию или обновления их цен. UpdatePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)

Передает данные об остатках товаров на витрине.

Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateStocksRequest UpdateStocksRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Fby

Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)

Скрывает товары магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddHiddenOffersRequest AddHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки скрытия получены и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)

Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.

{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}

Вначале такой товар нужно распродать или вывезти.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddOffersToArchiveRequest AddOffersToArchiveRequest (required)
Body Parameter

Return type

AddOffersToArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notArchivedOffers" : [ {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    }, {
      "offerId" : "offerId",
      "error" : "OFFER_HAS_STOCKS"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.

Список успешно добавленных товаров не возвращается.

AddOffersToArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

|⚙️ Лимит: 100 запросов в минуту| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CalculateTariffsRequest CalculateTariffsRequest (required)
Body Parameter

Return type

CalculateTariffsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Стоимость услуг. CalculateTariffsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.

Основная цена задается в каталоге и действует во всех магазинах кабинета.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)

Создает новый чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateChatRequest CreateChatRequest (required)
Body Parameter

Return type

CreateChatResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chatId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: чат создан. CreateChatResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)

Удаляет заданные товары из заданного магазина.

{% note warning "Запрос удаляет товары именно из конкретного магазина" %}

На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.

{% endnote %}

Товар не получится удалить, если он хранится на складах Маркета.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteCampaignOffersRequest DeleteCampaignOffersRequest (required)
Body Parameter

Return type

DeleteCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)

Удаляет комментарий магазина.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteGoodsFeedbackCommentRequest DeleteGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)

Возобновляет показ скрытых вами товаров магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteHiddenOffersRequest DeleteHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Показ товаров возобновлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)

Удаляет товары из каталога.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersRequest DeleteOffersRequest (required)
Body Parameter

Return type

DeleteOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)

Восстанавливает товары из архива.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteOffersFromArchiveRequest DeleteOffersFromArchiveRequest (required)
Body Parameter

Return type

DeleteOffersFromArchiveResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notUnarchivedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.

Список успешно восстановленных товаров не возвращается.

DeleteOffersFromArchiveResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)

Убирает товары из акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeletePromoOffersRequest DeletePromoOffersRequest (required)
Body Parameter

Return type

DeletePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат удаления товаров из акции. DeletePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)

Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateBoostConsolidatedRequest GenerateBoostConsolidatedRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)

Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

{% note info "Значение -1 в отчете" %}

Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.

{% endnote %}

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateCompetitorsPositionReportRequest GenerateCompetitorsPositionReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)

Запускает генерацию отчета по отзывам о товарах. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsFeedbackRequest GenerateGoodsFeedbackRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-movement/generate
Отчет по движению товаров (generateGoodsMovementReport)

Запускает генерацию отчета по движению товаров. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsMovementReportRequest GenerateGoodsMovementReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)

Запускает генерацию отчета по реализации за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsRealizationReportRequest GenerateGoodsRealizationReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-turnover/generate
Отчет по оборачиваемости (generateGoodsTurnoverReport)

Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsTurnoverRequest GenerateGoodsTurnoverRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)

Запускает генерацию отчета «Цены на рынке».

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GeneratePricesReportRequest GeneratePricesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShelfsStatisticsRequest GenerateShelfsStatisticsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShowsSalesReportRequest GenerateShowsSalesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateStocksOnWarehousesReportRequest GenerateStocksOnWarehousesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-----------------------------|---------------------------------| |По дате начисления услуги |dateFrom и dateTo | |По дате формирования акта |year и month |

Заказать отчеты обоих типов одним запросом нельзя.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedMarketplaceServicesReportRequest GenerateUnitedMarketplaceServicesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-------------------------|---------------------------------------| |О платежах за период |dateFrom и dateTo | |О платежном поручении |bankOrderId и bankOrderDateTime |

Заказать отчеты обоих типов одним запросом нельзя.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedNettingReportRequest GenerateUnitedNettingReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)

Запускает генерацию отчета по заказам за заданный период. Что это за отчет

{% note info "" %}

Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам

{% endnote %}

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedOrdersRequest GenerateUnitedOrdersRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter

Номер сегмента с результатами.

Значение по умолчанию: 0.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.

{% endnote %}

default: null format: int32

Return type

GetAllOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetAllOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)

Возвращает значения ставок для заданных товаров.

{% note warning "" %}

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsInfoRequest GetBidsInfoRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetBidsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "bids" : [ {
      "sku" : "sku",
      "bid" : 570
    }, {
      "sku" : "sku",
      "bid" : 570
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки. GetBidsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetBidsRecommendationsRequest GetBidsRecommendationsRequest (required)
Body Parameter

Return type

GetBidsRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "recommendations" : [ {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    }, {
      "bidRecommendations" : [ {
        "showPercent" : 8,
        "bid" : 570
      }, {
        "showPercent" : 8,
        "bid" : 570
      } ],
      "priceRecommendations" : [ {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      }, {
        "campaignId" : 6,
        "price" : 1.1465812980502945
      } ],
      "sku" : "sku",
      "bid" : 570
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Рекомендованные ставки для заданных товаров. GetBidsRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetBusinessSettingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "settings" : {
      "currency" : "RUR",
      "onlyDefaultPrice" : true
    },
    "info" : {
      "name" : "name",
      "id" : 0
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки кабинета. GetBusinessSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignResponse

Example data

Content-Type: application/json
{
  "campaign" : {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазине. GetCampaignResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignLoginsResponse

Example data

Content-Type: application/json
{
  "logins" : [ "logins", "logins" ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список логинов, связанных с магазином. GetCampaignLoginsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCampaignOffersRequest GetCampaignOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    }, {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, размещенных в заданном магазине. GetCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)

{% note warning "" %}

Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.

{% endnote %}

Возвращает регион, в котором находится магазин. |⚙️ Лимит: 5 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignRegionResponse

Example data

Content-Type: application/json
{
  "region" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращает регион, в котором находится магазин.

|⚙️ Лимит: 1000 запросов в час| |-|

GetCampaignRegionResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetCampaignSettingsResponse

Example data

Content-Type: application/json
{
  "settings" : {
    "showInPremium" : true,
    "showInContext" : true,
    "localRegion" : {
      "delivery" : {
        "schedule" : {
          "customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
          "period" : {
            "fromDate" : "23-09-2022",
            "toDate" : "23-09-2022"
          },
          "customHolidays" : [ "23-09-2022", "23-09-2022" ],
          "weeklyHolidays" : [ 1, 1 ],
          "availableOnHolidays" : true,
          "totalHolidays" : [ "23-09-2022", "23-09-2022" ]
        }
      },
      "name" : "name",
      "id" : 6,
      "type" : "OTHER",
      "deliveryOptionsSource" : "WEB"
    },
    "countryRegion" : 0,
    "shopName" : "shopName",
    "useOpenStat" : true
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки магазина. GetCampaignSettingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов. |⚙️ Лимит: 1000 запросов в час| |-|

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Магазины пользователя. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

login (required)
Path Parameter — Логин пользователя. default: null

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetCampaignsResponse

Example data

Content-Type: application/json
{
  "campaigns" : [ {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  }, {
    "clientId" : 6,
    "business" : {
      "name" : "name",
      "id" : 0
    },
    "domain" : "domain",
    "placementType" : "FBS",
    "id" : 0
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о магазинах. GetCampaignsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)

Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.

Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.

Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesMaxSaleQuantumRequest GetCategoriesMaxSaleQuantumRequest (required)
Body Parameter

Return type

GetCategoriesMaxSaleQuantumResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  }, {
    "maxSaleQuantum" : 6,
    "name" : "name",
    "id" : 0
  } ],
  "errors" : [ {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  }, {
    "type" : "UNKNOWN_CATEGORY",
    "categoryId" : 1
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Лимит на установку кванта и минимального количества товаров. GetCategoriesMaxSaleQuantumResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /categories/tree
Дерево категорий (getCategoriesTree)

Возвращает дерево категорий Маркета.

|⚙️ Лимит: 1 000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCategoriesRequest GetCategoriesRequest (optional)
Body Parameter

Return type

GetCategoriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Категории Маркета. GetCategoriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)

Возвращает список характеристик с допустимыми значениями для заданной категории.

|⚙️ Лимит: 50 категорий в минуту | |-|

Path parameters

categoryId (required)
Path Parameter

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

default: null format: int64

Return type

GetCategoryContentParametersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parameters" : [ {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    }, {
      "values" : [ {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      }, {
        "description" : "description",
        "id" : 5,
        "value" : "value"
      } ],
      "recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
      "description" : "description",
      "type" : "TEXT",
      "constraints" : {
        "minValue" : 2.3021358869347655,
        "maxValue" : 7.061401241503109,
        "maxLength" : 9
      },
      "required" : true,
      "multivalue" : true,
      "unit" : {
        "defaultUnitId" : 1,
        "units" : [ {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        }, {
          "name" : "кг",
          "fullName" : "килограмм",
          "id" : 5
        } ]
      },
      "valueRestrictions" : [ {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      }, {
        "limitedValues" : [ {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        }, {
          "limitingOptionValueId" : 2,
          "optionValueIds" : [ 4, 4 ]
        } ],
        "limitingParameterId" : 3
      } ],
      "distinctive" : true,
      "name" : "name",
      "id" : 6,
      "filtering" : true,
      "allowCustomValues" : true
    } ],
    "categoryId" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список характеристик товаров из заданной категории. GetCategoryContentParametersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)

Возвращает историю сообщений в чате с покупателем.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatHistoryRequest GetChatHistoryRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatHistoryResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderId" : 0,
    "messages" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "sender" : "PARTNER",
      "payload" : [ {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      }, {
        "size" : 1,
        "name" : "name",
        "url" : "url"
      } ],
      "messageId" : 6,
      "message" : "message"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

История сообщений успешно получена. GetChatHistoryResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)

Возвращает ваши чаты с покупателями.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetChatsRequest GetChatsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetChatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "chats" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "chatId" : 0,
      "orderId" : 6,
      "type" : "CHAT",
      "status" : "NEW",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список чатов. GetChatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

GetFeedResponse

Example data

Content-Type: application/json
{
  "feed" : {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о прайс-листе. GetFeedResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Query parameters

limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

default: null format: date-time
published_time_to (optional)
Query Parameter

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

{% endnote %}

default: null format: date-time
status (optional)
Query Parameter

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.
default: null

Return type

GetFeedIndexLogsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feed" : {
      "id" : 0
    },
    "total" : 2,
    "indexLogRecords" : [ {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    }, {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по индексации прайс-листа. GetFeedIndexLogsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает новые и обновленные отзывы о магазине на Маркете.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.

|⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter

Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: ГГГГ-ММ-ДД.

default: null format: date

Return type

GetFeedbackListResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "feedbackList" : [ {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    }, {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов для магазина. GetFeedbackListResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetFeedsResponse

Example data

Content-Type: application/json
{
  "feeds" : [ {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }, {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список прайс-листов. GetFeedsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /warehouses
Идентификаторы складов Маркета (FBY) (getFulfillmentWarehouses)

Возвращает список складов Маркета с их идентификаторами.

|⚙️ Лимит: 100 запросов в минуту| |-|

Return type

GetFulfillmentWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "name" : "name",
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "name" : "name",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов. GetFulfillmentWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)

Возвращает комментарии к отзыву.

Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackCommentsRequest GetGoodsFeedbackCommentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackCommentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "comments" : [ {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    }, {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Дерево комментариев к отзыву. GetGoodsFeedbackCommentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)

Возвращает все отзывы о товарах продавца по указанным фильтрам.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.

Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackRequest GetGoodsFeedbackRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feedbacks" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов. GetGoodsFeedbackResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsStatsRequest GetGoodsStatsRequest (required)
Body Parameter

Return type

GetGoodsStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "shopSkus" : [ {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по товарам. GetGoodsStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)

Возвращает список скрытых вами товаров для заданного магазина.

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

default: null format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetHiddenOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "hiddenOffers" : [ {
      "offerId" : "offerId"
    }, {
      "offerId" : "offerId"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о скрытых вами товарах. GetHiddenOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)

Возвращает сведения о состоянии контента для заданных товаров:

|⚙️ Лимит: 600 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferCardsContentStatusRequest GetOfferCardsContentStatusRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferCardsContentStatusResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerCards" : [ {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    }, {
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "offerId" : "offerId",
      "contentRating" : 0,
      "recommendations" : [ {
        "type" : "HAS_VIDEO",
        "percent" : 60
      }, {
        "type" : "HAS_VIDEO",
        "percent" : 60
      } ],
      "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "parameterValues" : [ {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      }, {
        "valueId" : 5,
        "parameterId" : 1,
        "unitId" : 5,
        "value" : "value"
      } ]
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о карточках указанных товаров. GetOfferCardsContentStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:

Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.

{% note info %}

Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter

Ваш SKU товара.

Параметр может быть указан несколько раз, например:

...shop_sku=123&shop_sku=129&shop_sku=141...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter

Фильтрация по статусу публикации товара:

  • READY — товар прошел модерацию.
  • IN_WORK — товар проходит модерацию.
  • NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
  • NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
  • REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
  • SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
  • OTHER — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
availability (optional)
Query Parameter

Фильтрация по планам поставок товара:

  • ACTIVE — поставки будут.
  • INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
  • DELISTED — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
category_id (optional)
Query Parameter

Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
vendor (optional)
Query Parameter

Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerMappingEntries" : [ {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    }, {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferMappingsRequest GetOfferMappingsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerMappings" : [ {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "downloadable" : true,
        "sellingPrograms" : [ {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        }, {
          "sellingProgram" : "FBY",
          "status" : "FINE"
        } ],
        "marketCategoryId" : 0,
        "manufacturerCountries" : [ "Россия", "Россия" ],
        "description" : "description",
        "videos" : [ "videos", "videos", "videos", "videos", "videos" ],
        "purchasePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "type" : "DEFAULT",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "archived" : true,
        "campaigns" : [ {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        }, {
          "campaignId" : 9,
          "status" : "PUBLISHED"
        } ],
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "discountBase" : 0.23021358869347652,
          "currencyId" : "RUR",
          "value" : 0.5637376656633328,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "params" : [ {
          "name" : "Wi-Fi",
          "value" : "есть"
        }, {
          "name" : "Wi-Fi",
          "value" : "есть"
        } ],
        "tags" : [ "до 500 рублей", "до 500 рублей" ],
        "condition" : {
          "reason" : "reason",
          "type" : "PREOWNED",
          "quality" : "PERFECT"
        },
        "certificates" : [ "certificates", "certificates" ],
        "boxCount" : 1,
        "additionalExpenses" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "customsCommodityCode" : "8517610008",
        "adult" : true,
        "age" : {
          "ageUnit" : "YEAR",
          "value" : 0.5962133916683182
        },
        "manuals" : [ {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        }, {
          "title" : "title",
          "url" : "url"
        } ]
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)

Метод возвращает рекомендации нескольких типов.

1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.

Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено

2. Оценка привлекательности цен на витрине.

Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferRecommendationsRequest GetOfferRecommendationsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerRecommendations" : [ {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    }, {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с рекомендациями. GetOfferRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.

Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

{% note info %}

Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

{% endnote %}

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

query (optional)
Query Parameter

Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

default: null
currency (optional)
Query Parameter

Валюта, в которой указана цена предложения.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

default: null
matched (optional)
Query Parameter

Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

  • 0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

  • 1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)

Возвращает информацию о заказе.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказе. GetOrderResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "organizationName" : "organizationName",
    "organizationJurAddress" : "organizationJurAddress",
    "inn" : "inn",
    "kpp" : "kpp"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetBusinessBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)

Возвращает информацию о документах по идентификатору заказа.

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessDocumentsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "sf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "torgTwelve" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "upd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ukd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ksf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о документах. GetBusinessDocumentsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.

Доступна фильтрация по нескольким характеристикам заказов:

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.

Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter

Статус заказа:

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
substatus (optional)
Query Parameter

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.
  • SHIPPED — заказ передан службе доставки.

Возможные значения для заказа в статусе CANCELLED:

  • DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

  • USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.

  • CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате оформления.

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.

Значение по умолчанию: 30 дней назад от текущей даты.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате оформления.

Показываются заказы, созданные до 00:00 указанного дня.

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.

Значение по умолчанию: текущая дата.

default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date
supplierShipmentDateTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date
updatedAtFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date-time
updatedAtTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter

Фильтрация заказов по типам:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

default: false
hasCis (optional)
Query Parameter

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.

  • false — нет.

Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter

Только для модели DBS

Фильтрация заказов по наличию запросов покупателей на отмену.

При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.

Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

default: false
onlyEstimatedDelivery (optional)
Query Parameter

Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:

  • true — возвращаются только заказы с неподтвержденной датой доставки.
  • false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "orders" : [ {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }, {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах. GetOrdersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

{% note info "" %}

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

{% endnote %}

В одном запросе можно получить информацию не более чем по 200 заказам.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOrdersStatsRequest GetOrdersStatsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    }, {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по заказам. GetOrdersStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.

{% endnote %}

Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.

{% note info %}

Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.

{% endnote %}

Способы установки цен описаны в Справке Маркета для продавцов.

|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false

Return type

GetPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "total" : 6,
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список всех товаров с установленными ценами. GetPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)

Возвращает список цен на указанные товары в магазине.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPricesByOfferIdsRequest GetPricesByOfferIdsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPricesByOfferIdsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с установленными для заданного магазина ценами. GetPricesByOfferIdsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)

Возвращает список товаров, которые участвуют или могут участвовать в акции.

{% note warning %}

В параметре limit не передавайте значение больше 500.

{% endnote %}

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromoOffersRequest GetPromoOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    }, {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, которые участвуют или могут участвовать в акции. GetPromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)

Возвращает информацию об акциях Маркета.

По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromosRequest GetPromosRequest (optional)
Body Parameter

Return type

GetPromosResponse

Example data

Content-Type: application/json
{
  "result" : {
    "promos" : [ {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    }, {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список акций Маркета. GetPromosResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQualityRatingRequest GetQualityRatingRequest (required)
Body Parameter

Return type

GetQualityRatingResponse

Example data

Content-Type: application/json
{
  "result" : {
    "campaignRatings" : [ {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    }, {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значение индекса качества магазинов и его составляющие. GetQualityRatingResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null

Return type

GetReportInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
    "file" : "file",
    "generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
    "subStatus" : "NO_DATA",
    "status" : "PENDING",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус генерации отчета и ссылка, если она уже есть.

{% note tip %}

Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.

{% endnote %}

 

GetReportInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)

Получает информацию по одному невыкупу или возврату.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

GetReturnResponse

Example data

Content-Type: application/json
{
  "result" : {
    "updateDate" : "2000-01-23T04:56:07.000+00:00",
    "fastReturn" : true,
    "orderId" : 6,
    "shipmentRecipientType" : "SHOP",
    "refundStatus" : "STARTED_BY_USER",
    "logisticPickupPoint" : {
      "logisticPartnerId" : 5,
      "address" : {
        "country" : "Россия",
        "city" : "Москва",
        "street" : "Стрелецкая улица",
        "postcode" : "123518",
        "house" : "9к2"
      },
      "instruction" : "instruction",
      "name" : "name",
      "id" : 1,
      "type" : "WAREHOUSE"
    },
    "id" : 0,
    "creationDate" : "2000-01-23T04:56:07.000+00:00",
    "items" : [ {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    }, {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    } ],
    "returnType" : "UNREDEEMED",
    "shipmentStatus" : "CREATED",
    "refundAmount" : 5
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. GetReturnResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)

Получает фотографии, которые покупатель приложил к заявлению на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Фотография возврата. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

default: null format: int64
statuses (optional)
Query Parameter

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

default: null
type (optional)
Query Parameter

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
from_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте fromDate.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date
to_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте toDate.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date

Return type

GetReturnsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "returns" : [ {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    }, {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Постраничные возвраты партнера. GetReturnsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)

Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).

{% note info "По умолчанию данные по оборачивамости не возращаются" %}

Чтобы они были в ответе, передавайте true в поле withTurnover.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetWarehouseStocksRequest GetWarehouseStocksRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetWarehouseStocksResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    }, {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Остатки товаров на складах. GetWarehouseStocksResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.

{% endnote %}

Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.

Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:

##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##

Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.

Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.

В одном запросе можно получить не более 500 рекомендаций.

|⚙️ Лимит: 100 000 рекомендаций в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingEntriesRequest GetSuggestedOfferMappingEntriesRequest (required)
Body Parameter

Return type

GetSuggestedOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    }, {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetSuggestedOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

{% endnote %}

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingsRequest GetSuggestedOfferMappingsRequest (optional)
Body Parameter

Return type

GetSuggestedOfferMappingsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    }, {
      "offer" : {
        "vendor" : "LEVENHUK",
        "basicPrice" : {
          "value" : 0.9301444243932576
        },
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "offerId" : "offerId",
        "description" : "description",
        "category" : "category",
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "vendorCode" : "VNDR-0005A"
      },
      "mapping" : {
        "marketSkuName" : "marketSkuName",
        "marketCategoryName" : "marketCategoryName",
        "marketCategoryId" : 4,
        "marketSku" : 3,
        "marketModelId" : 2,
        "marketModelName" : "marketModelName"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

GetSuggestedOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте отчет «Цены на рынке».

{% endnote %}

{% note warning "" %}

Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.

{% endnote %}

Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.

Товары, для которых нужно получить цены, передаются в теле POST-запроса.

Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.

Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.

Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.

Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SuggestPricesRequest SuggestPricesRequest (required)
Body Parameter

Return type

SuggestPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    }, {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список цен для продвижения на Маркете. SuggestPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

{% cut "Как в кабинете выглядит кампания, созданная через API" %}

{% endcut %}

При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.

При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.

Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.

Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.

Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.

Внести другие изменения в созданную через API кампанию можно в кабинете:

Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.

Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.

{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}

𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.

{% endnote %}

В одном запросе может быть максимум 1500 товаров.

|⚙️ Лимит: 1000 запросов в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PutSkuBidsRequest PutSkuBidsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

  1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
  2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh.
  3. Маркет начинает обновление данных магазина на сервисе.

{% note alert %}

Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

{% endnote %}

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetRegionWithChildrenResponse

Example data

Content-Type: application/json
{
  "regions" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  },
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Регионы, являющиеся дочерними к указанному в запросе. GetRegionWithChildrenResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)

Возвращает информацию о регионе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденный регион. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions
Поиск регионов по их имени (searchRegionsByName)

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Query parameters

name (required)
Query Parameter

Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список найденных регионов. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)

Отправляет файл в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Form parameters

file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что файл отправлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)

Отправляет сообщение в чат с покупателем.

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SendMessageToChatRequest SendMessageToChatRequest (required)
Body Parameter

Query parameters

chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. Означает, что сообщение отправлено. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetFeedParamsRequest SetFeedParamsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов POST businesses/{businessId}/goods-feedback.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SkipGoodsFeedbackReactionRequest SkipGoodsFeedbackReactionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)

Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateBusinessPricesRequest UpdateBusinessPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateCampaignOffersRequest UpdateCampaignOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.

Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.

Чтобы добавить комментарий к другому комментарию, передайте:

Чтобы изменить комментарий, передайте:

Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateGoodsFeedbackCommentRequest UpdateGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

UpdateGoodsFeedbackCommentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "author" : {
      "name" : "name",
      "type" : "USER"
    },
    "id" : 0,
    "text" : "text",
    "canModify" : true,
    "parentId" : 6,
    "status" : "PUBLISHED"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о добавленном или измененном комментарии. UpdateGoodsFeedbackCommentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)

Редактирует характеристики товара, которые специфичны для категории, к которой он относится.

{% note warning "Здесь только то, что относится к конкретной категории" %}

Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferContentRequest UpdateOfferContentRequest (required)
Body Parameter

Return type

UpdateOfferContentResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "OFFER_NOT_FOUND",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос выполнен корректно, данные обработаны.

{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

{% endnote %}

Если в status вернулось ERROR, убедитесь, что:

Найти проблемы помогут поля errors и warnings.

UpdateOfferContentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.

Информацию о товарах нужно передать в теле POST-запроса.

У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:

В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.

Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

В одном запросе можно добавить не более 500 товаров.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingEntryRequest UpdateOfferMappingEntryRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)

Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.

Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.

Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

{% note warning "Правила использования SKU" %}

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingsRequest UpdateOfferMappingsRequest (required)
Body Parameter

Return type

UpdateOfferMappingsResponse

Example data

Content-Type: application/json
{
  "results" : [ {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  }, {
    "warnings" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ],
    "offerId" : "offerId",
    "errors" : [ {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    }, {
      "parameterId" : 0,
      "type" : "UNKNOWN_CATEGORY",
      "message" : "message"
    } ]
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге. UpdateOfferMappingsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePricesRequest UpdatePricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePromoOffersRequest UpdatePromoOffersRequest (required)
Body Parameter

Return type

UpdatePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ],
    "warningOffers" : [ {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    }, {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат добавления товаров в акцию или обновления их цен. UpdatePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Feedbacks

Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает новые и обновленные отзывы о магазине на Маркете.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.

|⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter

Начальная дата обновления отзывов.

Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.

Формат даты: ГГГГ-ММ-ДД.

default: null format: date

Return type

GetFeedbackListResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "feedbackList" : [ {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    }, {
      "comments" : [ {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "createdAt" : "2000-01-23T04:56:07.000+00:00",
        "children" : [ null, null ],
        "author" : {
          "name" : "name",
          "type" : "USER"
        },
        "id" : 6,
        "body" : "body",
        "parentId" : 1,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "shop" : {
        "name" : "name"
      },
      "author" : {
        "name" : "name",
        "region" : {
          "children" : [ null, null ],
          "name" : "name",
          "id" : 0,
          "type" : "OTHER"
        }
      },
      "verified" : true,
      "recommend" : true,
      "grades" : {
        "average" : 5.962133916683182,
        "agreeCount" : 5,
        "rejectCount" : 2,
        "factors" : [ {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        }, {
          "description" : "description",
          "id" : 7,
          "title" : "title",
          "value" : 9
        } ]
      },
      "pro" : "pro",
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "id" : 0,
      "text" : "text",
      "state" : "LAST",
      "contra" : "contra",
      "resolved" : true,
      "order" : {
        "delivery" : "DELIVERY",
        "shopOrderId" : "shopOrderId"
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов для магазина. GetFeedbackListResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Feeds

Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

GetFeedResponse

Example data

Content-Type: application/json
{
  "feed" : {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о прайс-листе. GetFeedResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Query parameters

limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

default: null format: date-time
published_time_to (optional)
Query Parameter

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

{% note info %}

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

{% endnote %}

default: null format: date-time
status (optional)
Query Parameter

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.
default: null

Return type

GetFeedIndexLogsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feed" : {
      "id" : 0
    },
    "total" : 2,
    "indexLogRecords" : [ {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    }, {
      "offers" : {
        "rejectedCount" : 5,
        "totalCount" : 5
      },
      "fileTime" : "2000-01-23T04:56:07.000+00:00",
      "generationId" : 6,
      "indexType" : "DIFF",
      "publishedTime" : "2000-01-23T04:56:07.000+00:00",
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 1
      },
      "downloadTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ERROR"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по индексации прайс-листа. GetFeedIndexLogsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetFeedsResponse

Example data

Content-Type: application/json
{
  "feeds" : [ {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  }, {
    "password" : "password",
    "download" : {
      "error" : {
        "description" : "description",
        "type" : "DOWNLOAD_ERROR",
        "httpStatusCode" : 5
      }
    },
    "uploadDate" : "2000-01-23T04:56:07.000+00:00",
    "publication" : {
      "priceAndStockUpdate" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      },
      "full" : {
        "fileTime" : "2000-01-23T04:56:07.000+00:00",
        "publishedTime" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "name" : "name",
    "id" : 0,
    "placement" : {
      "totalOffersCount" : 5
    },
    "login" : "login",
    "url" : "url",
    "content" : {
      "rejectedOffersCount" : 6,
      "error" : {
        "type" : "PARSE_ERROR"
      },
      "status" : "ERROR",
      "totalOffersCount" : 1
    }
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список прайс-листов. GetFeedsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

  1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
  2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh.
  3. Маркет начинает обновление данных магазина на сервисе.

{% note alert %}

Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

{% endnote %}

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

|⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetFeedParamsRequest SetFeedParamsRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

GoodsFeedback

Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)

Удаляет комментарий магазина.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteGoodsFeedbackCommentRequest DeleteGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)

Возвращает комментарии к отзыву.

Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.

Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackCommentsRequest GetGoodsFeedbackCommentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackCommentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "comments" : [ {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    }, {
      "author" : {
        "name" : "name",
        "type" : "USER"
      },
      "id" : 0,
      "text" : "text",
      "canModify" : true,
      "parentId" : 6,
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Дерево комментариев к отзыву. GetGoodsFeedbackCommentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)

Возвращает все отзывы о товарах продавца по указанным фильтрам.

Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.

Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsFeedbackRequest GetGoodsFeedbackRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetGoodsFeedbackResponse

Example data

Content-Type: application/json
{
  "result" : {
    "feedbacks" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "needReaction" : true,
      "identifiers" : {
        "orderId" : 6,
        "modelId" : 1
      },
      "author" : "author",
      "feedbackId" : 0,
      "description" : {
        "advantages" : "advantages",
        "disadvantages" : "disadvantages",
        "comment" : "comment"
      },
      "media" : {
        "videos" : [ "videos", "videos" ],
        "photos" : [ "photos", "photos" ]
      },
      "statistics" : {
        "commentsCount" : 5,
        "rating" : 3,
        "paidAmount" : 2,
        "recommended" : true
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список отзывов. GetGoodsFeedbackResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)

Пропускает отзывы — они больше не будут возвращаться в методе получения всех отзывов POST businesses/{businessId}/goods-feedback.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SkipGoodsFeedbackReactionRequest SkipGoodsFeedbackReactionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)

Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.

Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.

Чтобы добавить комментарий к другому комментарию, передайте:

Чтобы изменить комментарий, передайте:

Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.

|⚙️ Лимит: 1 000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateGoodsFeedbackCommentRequest UpdateGoodsFeedbackCommentRequest (required)
Body Parameter

Return type

UpdateGoodsFeedbackCommentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "author" : {
      "name" : "name",
      "type" : "USER"
    },
    "id" : 0,
    "text" : "text",
    "canModify" : true,
    "parentId" : 6,
    "status" : "PUBLISHED"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о добавленном или измененном комментарии. UpdateGoodsFeedbackCommentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

GoodsStats

Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetGoodsStatsRequest GetGoodsStatsRequest (required)
Body Parameter

Return type

GetGoodsStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "shopSkus" : [ {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "shopSku" : "shopSku",
      "marketSku" : 0,
      "price" : 6.027456183070403,
      "name" : "name",
      "warehouses" : [ {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      }, {
        "name" : "name",
        "id" : 9,
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ]
      } ],
      "weightDimensions" : {
        "length" : 5.962133916683182,
        "width" : 5.637376656633329,
        "weight" : 7.061401241503109,
        "height" : 2.3021358869347655
      },
      "categoryName" : "categoryName",
      "categoryId" : 1,
      "pictures" : [ "pictures", "pictures" ],
      "tariffs" : [ {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 2.027123023002322,
        "type" : "AGENCY_COMMISSION",
        "percent" : 3.616076749251911,
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Отчет по товарам. GetGoodsStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

HiddenOffers

Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)

Скрывает товары магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AddHiddenOffersRequest AddHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Настройки скрытия получены и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)

Возобновляет показ скрытых вами товаров магазина на Маркете.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteHiddenOffersRequest DeleteHiddenOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Показ товаров возобновлен. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)

Возвращает список скрытых вами товаров для заданного магазина.

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

default: null format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetHiddenOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "hiddenOffers" : [ {
      "offerId" : "offerId"
    }, {
      "offerId" : "offerId"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о скрытых вами товарах. GetHiddenOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Models

Up
get /models/{modelId}
Информация об одной модели (getModel)

Возвращает информацию о модели товара.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Path parameters

modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null

Return type

GetModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "regionId" : 0,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о модели. GetModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /models/{modelId}/offers
Список предложений для одной модели (getModelOffers)

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.

Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.

Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.

Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Path parameters

modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
orderByPrice (optional)
Query Parameter

Направление сортировки по цене.

Возможные значения:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

default: null
count (optional)
Query Parameter — Количество предложений на странице ответа. default: 10 format: int32
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32

Return type

GetModelsOffersResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  }, {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  } ],
  "regionId" : 7,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список предложений для модели. GetModelsOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /models
Информация о нескольких моделях (getModels)

Возвращает информацию о моделях товаров.

В одном запросе можно получить информацию не более чем о 100 моделях.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetModelsRequest GetModelsRequest (required)
Body Parameter

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null

Return type

GetModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "regionId" : 0,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о моделях. GetModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /models/offers
Список предложений для нескольких моделей (getModelsOffers)

Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе.

Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.

Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются.

В одном запросе можно получить информацию о предложениях не более чем для 100 моделей.

Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetModelsRequest GetModelsRequest (required)
Body Parameter

Query parameters

regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
orderByPrice (optional)
Query Parameter

Направление сортировки по цене.

Возможные значения:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

default: null

Return type

GetModelsOffersResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  }, {
    "offers" : [ {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    }, {
      "shopRating" : 9,
      "preDiscountPrice" : 5.962133916683182,
      "shippingCost" : 7.061401241503109,
      "pos" : 1,
      "regionId" : 2,
      "price" : 5.637376656633329,
      "name" : "name",
      "discount" : 6,
      "shopName" : "shopName",
      "inStock" : 3
    } ],
    "onlineOffers" : 4,
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    },
    "offlineOffers" : 2
  } ],
  "regionId" : 7,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список предложений для моделей. GetModelsOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /models
Поиск модели товара (searchModels)

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска.

В одном запросе можно получить информацию не более чем о 100 моделях.

Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

|⚙️ Лимит: рассчитывается индивидуально| |-|

Query parameters

query (required)
Query Parameter — Поисковый запрос по названию модели товара. default: null
regionId (required)
Query Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64
currency (optional)
Query Parameter

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

SearchModelsResponse

Example data

Content-Type: application/json
{
  "models" : [ {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  }, {
    "name" : "name",
    "id" : 0,
    "prices" : {
      "avg" : 6.027456183070403,
      "min" : 5.962133916683182,
      "max" : 1.4658129805029452
    }
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "regionId" : 5,
  "currency" : "RUR"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о моделях. SearchModelsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OfferMappings

Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:

Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.

{% note info %}

Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter

Ваш SKU товара.

Параметр может быть указан несколько раз, например:

...shop_sku=123&shop_sku=129&shop_sku=141...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter

Фильтрация по статусу публикации товара:

  • READY — товар прошел модерацию.
  • IN_WORK — товар проходит модерацию.
  • NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.
  • NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.
  • REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.
  • SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
  • OTHER — товар не прошел модерацию по другой причине.

Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
availability (optional)
Query Parameter

Фильтрация по планам поставок товара:

  • ACTIVE — поставки будут.
  • INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.
  • DELISTED — архив: товар закончился на складе, и его поставок больше не будет.

Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
category_id (optional)
Query Parameter

Фильтрация по идентификатору категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
vendor (optional)
Query Parameter

Фильтрация по бренду товара.

Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.

Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.

В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offerMappingEntries" : [ {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    }, {
      "offer" : {
        "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
        "certificate" : "certificate",
        "description" : "description",
        "availability" : "ACTIVE",
        "pictures" : [ "pictures", "pictures" ],
        "vendorCode" : "VNDR-0005A",
        "manufacturer" : "manufacturer",
        "urls" : [ "urls", "urls" ],
        "deliveryDurationDays" : 5,
        "feedId" : 0,
        "vendor" : "LEVENHUK",
        "price" : 2.027123023002322,
        "transportUnitSize" : 1,
        "id" : "id",
        "lifeTime" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "shelfLife" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
        "lifeTimeDays" : 9,
        "quantumOfSupply" : 5,
        "barcodes" : [ "46012300000000", "46012300000000" ],
        "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
        "processingState" : {
          "notes" : [ {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          }, {
            "payload" : "payload",
            "type" : "ASSORTMENT"
          } ],
          "status" : "UNKNOWN"
        },
        "shopSku" : "shopSku",
        "boxCount" : 2,
        "minShipment" : 6,
        "name" : "Ударная дрель Makita HP1630, 710 Вт",
        "shelfLifeDays" : 7,
        "guaranteePeriod" : {
          "timePeriod" : 6,
          "comment" : "comment",
          "timeUnit" : "HOUR"
        },
        "weightDimensions" : {
          "length" : 65.55,
          "width" : 50.7,
          "weight" : 1.001,
          "height" : 20
        },
        "category" : "category",
        "guaranteePeriodDays" : 3
      },
      "mapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "awaitingModerationMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      },
      "rejectedMapping" : {
        "modelId" : 7,
        "marketSku" : 4,
        "categoryId" : 1
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.

{% endnote %}

Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.

Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:

##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##

Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.

Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.

В одном запросе можно получить не более 500 рекомендаций.

|⚙️ Лимит: 100 000 рекомендаций в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetSuggestedOfferMappingEntriesRequest GetSuggestedOfferMappingEntriesRequest (required)
Body Parameter

Return type

GetSuggestedOfferMappingEntriesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    }, {
      "manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
      "marketCategoryId" : 4,
      "certificate" : "certificate",
      "description" : "description",
      "availability" : "ACTIVE",
      "marketModelId" : 7,
      "pictures" : [ "pictures", "pictures" ],
      "vendorCode" : "VNDR-0005A",
      "manufacturer" : "manufacturer",
      "marketSkuName" : "marketSkuName",
      "urls" : [ "urls", "urls" ],
      "deliveryDurationDays" : 5,
      "feedId" : 0,
      "vendor" : "LEVENHUK",
      "price" : 2.027123023002322,
      "transportUnitSize" : 1,
      "id" : "id",
      "lifeTime" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "shelfLife" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
      "marketModelName" : "marketModelName",
      "lifeTimeDays" : 9,
      "quantumOfSupply" : 5,
      "barcodes" : [ "46012300000000", "46012300000000" ],
      "customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
      "processingState" : {
        "notes" : [ {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        }, {
          "payload" : "payload",
          "type" : "ASSORTMENT"
        } ],
        "status" : "UNKNOWN"
      },
      "marketCategoryName" : "marketCategoryName",
      "shopSku" : "shopSku",
      "boxCount" : 2,
      "minShipment" : 6,
      "name" : "Ударная дрель Makita HP1630, 710 Вт",
      "shelfLifeDays" : 7,
      "guaranteePeriod" : {
        "timePeriod" : 6,
        "comment" : "comment",
        "timeUnit" : "HOUR"
      },
      "weightDimensions" : {
        "length" : 65.55,
        "width" : 50.7,
        "weight" : 1.001,
        "height" : 20
      },
      "category" : "category",
      "guaranteePeriodDays" : 3
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о товарах в каталоге. GetSuggestedOfferMappingEntriesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.

{% endnote %}

Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.

Информацию о товарах нужно передать в теле POST-запроса.

У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:

В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.

Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.

В одном запросе можно добавить не более 500 товаров.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOfferMappingEntryRequest UpdateOfferMappingEntryRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Offers

Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)

Удаляет заданные товары из заданного магазина.

{% note warning "Запрос удаляет товары именно из конкретного магазина" %}

На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.

{% endnote %}

Товар не получится удалить, если он хранится на складах Маркета.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeleteCampaignOffersRequest DeleteCampaignOffersRequest (required)
Body Parameter

Return type

DeleteCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "notDeletedOfferIds" : [ null, null ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине. DeleteCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter

Номер сегмента с результатами.

Значение по умолчанию: 0.

{% note info %}

Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.

{% endnote %}

{% note alert %}

Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.

{% endnote %}

default: null format: int32

Return type

GetAllOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ]
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetAllOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)

Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetCampaignOffersRequest GetCampaignOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetCampaignOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    }, {
      "campaignPrice" : {
        "vat" : 5,
        "discountBase" : 5.962133916683182,
        "currencyId" : "RUR",
        "value" : 1.4658129805029452,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "basicPrice" : {
        "discountBase" : 0.23021358869347652,
        "currencyId" : "RUR",
        "value" : 0.5637376656633328,
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      },
      "warnings" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "available" : true,
      "offerId" : "offerId",
      "quantum" : {
        "minQuantity" : 1,
        "stepQuantity" : 60
      },
      "errors" : [ {
        "comment" : "comment",
        "message" : "message"
      }, {
        "comment" : "comment",
        "message" : "message"
      } ],
      "status" : "PUBLISHED"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, размещенных в заданном магазине. GetCampaignOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)

Метод возвращает рекомендации нескольких типов.

1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.

Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено

2. Оценка привлекательности цен на витрине.

Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOfferRecommendationsRequest GetOfferRecommendationsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOfferRecommendationsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    },
    "offerRecommendations" : [ {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    }, {
      "offer" : {
        "shows" : 0,
        "price" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitiveness" : "OPTIMAL",
        "cofinancePrice" : {
          "value" : 0.7061401241503109,
          "updatedAt" : "2000-01-23T04:56:07.000+00:00"
        }
      },
      "recommendation" : {
        "recommendedCofinancePrice" : {
          "value" : 0.9301444243932576
        },
        "offerId" : "offerId",
        "competitivenessThresholds" : {
          "optimalPrice" : {
            "value" : 0.9301444243932576
          },
          "averagePrice" : {
            "value" : 0.9301444243932576
          }
        }
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с рекомендациями. GetOfferRecommendationsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)

{% note warning "" %}

Этот метод устарел. Не используйте его.

{% endnote %}

Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.

Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

{% note info %}

Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

{% endnote %}

{% note info %}

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

query (optional)
Query Parameter

Поисковый запрос.

Поддерживается язык запросов.

Значение по умолчанию: все предложения магазина, размещенные на Маркете.

default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

default: null
currency (optional)
Query Parameter

Валюта, в которой указана цена предложения.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

default: null
matched (optional)
Query Parameter

Фильтр по признаку соотнесения предложения и карточки модели.

Возможные значения:

  • 0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.

  • 1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).

default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetOffersResponse

Example data

Content-Type: application/json
{
  "offers" : [ {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  }, {
    "marketCategoryId" : 1,
    "preDiscountPrice" : 5.962133916683182,
    "shopCategoryId" : "shopCategoryId",
    "modelId" : 2,
    "fee" : 3.616076749251911,
    "discount" : 5,
    "url" : "url",
    "cbid" : 9.301444243932576,
    "blocked" : true,
    "feedId" : 6,
    "price" : 0.8008281904610115,
    "name" : "name",
    "currency" : "RUR",
    "id" : "id",
    "cutPrice" : true,
    "bid" : 7.061401241503109
  } ],
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Предложения магазина. GetOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)

Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateCampaignOffersRequest UpdateCampaignOffersRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OrderBusinessInformation

Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "organizationName" : "organizationName",
    "organizationJurAddress" : "organizationJurAddress",
    "inn" : "inn",
    "kpp" : "kpp"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetBusinessBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)

Возвращает информацию о документах по идентификатору заказа.

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetBusinessDocumentsInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "sf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "torgTwelve" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "upd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ukd" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    },
    "ksf" : {
      "date" : "2000-01-23",
      "number" : "number",
      "status" : "READY"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о документах. GetBusinessDocumentsInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OrderDelivery

Up
get /campaigns/{campaignId}/orders/{orderId}/buyer
Информация о покупателе — физическом лице (getOrderBuyerInfo)

Возвращает информацию о покупателе по идентификатору заказа.

{% note info "" %}

Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer.

{% endnote %}

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.

Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.

|⚙️ Лимит: 3 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderBuyerInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "lastName" : "lastName",
    "firstName" : "firstName",
    "phone" : "phone",
    "middleName" : "middleName",
    "id" : "id",
    "type" : "PERSON"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о покупателе. GetOrderBuyerInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/date
Изменение даты доставки заказа (setOrderDeliveryDate)

Метод изменяет дату доставки заказа в статусе PROCESSING или DELIVERY. Для заказов с другими статусами дату доставки изменить нельзя.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderDeliveryDateRequest SetOrderDeliveryDateRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Успешное изменение даты доставки. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/delivery/track
Передача трек‑номера посылки (setOrderDeliveryTrackCode)

{% note warning "Этот запрос только для DBS" %}

Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти.

{% endnote %}

Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки.

Передать трек‑номер можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderDeliveryTrackCodeRequest SetOrderDeliveryTrackCodeRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Трек‑номер посылки и идентификатор службы доставки были успешно переданы. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit
Продление срока хранения заказа (updateOrderStorageLimit)

Продлевает срок хранения заказа в пункте выдачи продавца.

Заказ должен быть в статусе PICKUP. Продлить срок можно только один раз, не больше чем на 30 дней.

Новый срок хранения можно получить в параметре outletStorageLimitDate запроса GET campaigns/{campaignId}/orders/{orderId}.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStorageLimitRequest UpdateOrderStorageLimitRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/verifyEac
Передача кода подтверждения (verifyOrderEac)

Отправляет Маркету код подтверждения для его проверки.

Код подтверждает передачу заказа или невыкупа:

Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения.

Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа.

Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину.

Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VerifyOrderEacRequest VerifyOrderEacRequest (required)
Body Parameter

Return type

VerifyOrderEacResponse

Example data

Content-Type: application/json
{
  "result" : {
    "verificationResult" : "ACCEPTED",
    "attemptsLeft" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Проверка кода выполнена успешно. VerifyOrderEacResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OrderLabels

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)

Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все коробки. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderLabelsDataResponse

Example data

Content-Type: application/json
{
  "result" : {
    "parcelBoxLabels" : [ {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    }, {
      "supplierName" : "supplierName",
      "deliveryServiceId" : "deliveryServiceId",
      "orderId" : 1,
      "fulfilmentId" : "fulfilmentId",
      "orderNum" : "orderNum",
      "weight" : "weight",
      "url" : "url",
      "deliveryServiceName" : "deliveryServiceName",
      "deliveryAddress" : "deliveryAddress",
      "recipientName" : "recipientName",
      "place" : "place",
      "shipmentDate" : "shipmentDate",
      "boxId" : 5
    } ],
    "orderId" : 0,
    "placesNumber" : 6,
    "url" : "url"
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация для печати ярлыков. GetOrderLabelsDataResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Orders

Up
put /campaigns/{campaignId}/orders/{orderId}/cancellation/accept
Отмена заказа покупателем (acceptOrderCancellation)

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки.

Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.

Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут.

Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене.

Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.

|⚙️ Лимит: 500 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AcceptOrderCancellationRequest AcceptOrderCancellationRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ на отмену заказа был успешно передан. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)

Возвращает информацию о заказе.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Return type

GetOrderResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказе. GetOrderResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.

Доступна фильтрация по нескольким характеристикам заказов:

Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.

Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.

Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.

Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.

⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter

Статус заказа:

  • CANCELLED — заказ отменен.

  • DELIVERED — заказ получен покупателем.

  • DELIVERY — заказ передан в службу доставки.

  • PICKUP — заказ доставлен в пункт самовывоза.

  • PROCESSING — заказ находится в обработке.

  • UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
substatus (optional)
Query Parameter

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Возможные значения для заказа в статусе PROCESSING:

  • STARTED — заказ подтвержден, его можно начать обрабатывать.
  • READY_TO_SHIP — заказ собран и готов к отправке.
  • SHIPPED — заказ передан службе доставки.

Возможные значения для заказа в статусе CANCELLED:

  • DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.

  • PROCESSING_EXPIRED — значение более не используется.

  • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

  • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

  • RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.

  • SHOP_FAILED — магазин не может выполнить заказ.

  • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

  • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

  • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

  • USER_REFUSED_PRODUCT — покупателю не подошел товар.

  • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

  • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

    • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
    • перерыв между первым и третьим звонком не менее 90 минут;
    • соединение не короче 5 секунд.

    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

  • USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.

  • CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате оформления.

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.

Значение по умолчанию: 30 дней назад от текущей даты.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате оформления.

Показываются заказы, созданные до 00:00 указанного дня.

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.

Значение по умолчанию: текущая дата.

default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date
supplierShipmentDateTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).

Формат даты: ДД-ММ-ГГГГ.

Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date
updatedAtFrom (optional)
Query Parameter

Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.

Начальная дата включается в интервал для фильтрации.

default: null format: date-time
updatedAtTo (optional)
Query Parameter

Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.

Конечная дата не включается в интервал для фильтрации.

default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter

Фильтрация заказов по типам:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

default: false
hasCis (optional)
Query Parameter

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.

  • false — нет.

Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter

Только для модели DBS

Фильтрация заказов по наличию запросов покупателей на отмену.

При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.

Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

default: false
onlyEstimatedDelivery (optional)
Query Parameter

Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:

  • true — возвращаются только заказы с неподтвержденной датой доставки.
  • false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "orders" : [ {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }, {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах. GetOrdersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods
Передача ключей цифровых товаров (provideOrderDigitalCodes)

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED.

Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.

Если в один заказ входят несколько ключей, передавайте их все в одном запросе.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderDigitalCodesRequest ProvideOrderDigitalCodesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Передает Маркету коды маркировки для единиц товара в указанном заказе.

Принимаются коды следующих типов:

{% note warning %}

Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.

{% endnote %}

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvideOrderItemIdentifiersRequest ProvideOrderItemIdentifiersRequest (required)
Body Parameter

Return type

ProvideOrderItemIdentifiersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "items" : [ {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    }, {
      "offerName" : "offerName",
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "price" : 1.4658129805029452,
      "vat" : "NO_VAT",
      "count" : 6,
      "offerId" : "offerId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах. ProvideOrderItemIdentifiersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)

{% note tip "Подходит и для DBS" %}

Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.

{% endnote %}

Позволяет выполнить три операции:

Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.

Как передать информацию о распределении товаров

В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:

⚠️ Одна коробка не может содержать и товары целиком, и части товаров.

Как передавать коды маркировки

Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?

Принимаются коды следующих типов:

Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.

Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.

Как удалить товар из заказа

Чтобы удалить товар из заказа:

  1. Добавьте в запрос allowRemove: true.
  2. Передайте распределение по коробкам без товара, который нужно удалить.

{% note warning "Удаление нельзя отменить" %}

Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.

{% endnote %}

Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.

Нельзя удалить или уменьшить количество товара, если он:

Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Примеры

{% cut "Товар умещается в коробку" %}

Вот как будет выглядеть запрос, если в одной коробке едут:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "fullCount": 3,
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        },
                        {
                            "cis": "010304109478gftJ14545762!\u001dhGt264"
                        },
                        {
                            "cis": "010304109478fRs28323ks23!\u001dhet201"
                        }
                    ]
                },
                {
                    "id": 654321,
                    "fullCount": 1
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Товар едет в разных коробках" %}

Вот как будет выглядеть запрос, если товар едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}

Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:

{
    "boxes": [
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 1,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        },
        {
            "items": [
                {
                    "id": 123456,
                    "partialCount": {
                        "current": 2,
                        "total": 2
                    },
                    "instances": [
                        {
                            "cis": "01030410947874432155Qbag!\u001d93Zjqw"
                        }
                    ]
                }
            ]
        }
    ]
}

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderBoxLayoutRequest SetOrderBoxLayoutRequest (required)
Body Parameter

Return type

SetOrderBoxLayoutResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    }, {
      "items" : [ {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      }, {
        "partialCount" : {
          "current" : 1,
          "total" : 2
        },
        "instances" : [ {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        }, {
          "rnpt" : "rnpt",
          "gtd" : "gtd",
          "uin" : "uin",
          "cis" : "cis"
        } ],
        "id" : 0,
        "fullCount" : 1
      } ],
      "boxId" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков. SetOrderBoxLayoutResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.

Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.

Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.

Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.

{% cut "Как было раньше" %}

Структура тела PUT-запроса:

{
  "boxes":
  [
    {
      "fulfilmentId": "{string}",
      "weight": {int64},
      "width": {int64},
      "height": {int64},
      "depth": {int64},
      "items":
      [
        {
          "id": {int64},
          "count": {int32}
        },
        ...
      ]
    },
    ...
  ]
}

| Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | boxes | | Список грузовых мест. |

Параметры, вложенные в boxes | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. | | weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | width | Int64 | Ширина грузового места в сантиметрах. | | height | Int64 | Высота грузового места в сантиметрах. | | depth | Int64 | Глубина грузового места в сантиметрах. | | items | Int64 | Список товаров в грузовом месте. |

Параметры, вложенные в items | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | id | Int64 | Идентификатор товара в рамках заказа. | | count | Int32 | Количество единиц товара в грузовом месте. |

{% endcut %}

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetOrderShipmentBoxesRequest SetOrderShipmentBoxesRequest (required)
Body Parameter

Return type

SetOrderShipmentBoxesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "boxes" : [ {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    }, {
      "fulfilmentId" : "fulfilmentId",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество грузомест записано. SetOrderShipmentBoxesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)

{% note warning "Этот запрос только для DBS" %}

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

{% endnote %}

Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:

Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.

Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.

Чтобы полностью удалить товар из заказа:

Нельзя удалить или уменьшить количество товара, если он:

Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.

{% note info "Увеличить заказ нельзя" %}

С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.

{% endnote %}

Возврат денег покупателю

Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderItemRequest UpdateOrderItemRequest (required)
Body Parameter

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)

Изменяет статус заказа. Возможные изменения статусов:

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusRequest UpdateOrderStatusRequest (required)
Body Parameter

Return type

UpdateOrderStatusResponse

Example data

Content-Type: application/json
{
  "order" : {
    "delivery" : {
      "dispatchType" : "UNKNOWN",
      "address" : {
        "country" : "country",
        "city" : "city",
        "postcode" : "postcode",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "house" : "house",
        "subway" : "subway",
        "phone" : "phone",
        "street" : "street",
        "district" : "district",
        "recipient" : "recipient",
        "entryphone" : "entryphone",
        "block" : "block",
        "entrance" : "entrance",
        "floor" : "floor",
        "apartment" : "apartment"
      },
      "liftType" : "NOT_NEEDED",
      "deliveryServiceId" : 6,
      "estimated" : true,
      "dates" : {
        "fromDate" : "23-09-2022",
        "toDate" : "23-09-2022",
        "fromTime" : "fromTime",
        "toTime" : "toTime",
        "realDeliveryDate" : "23-09-2022"
      },
      "type" : "DELIVERY",
      "serviceName" : "serviceName",
      "shipments" : [ {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      }, {
        "boxes" : [ {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        }, {
          "fulfilmentId" : "fulfilmentId",
          "id" : 3
        } ],
        "id" : 6,
        "shipmentDate" : "23-09-2022",
        "shipmentTime" : "shipmentTime",
        "tracks" : [ {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        }, {
          "trackCode" : "trackCode",
          "deliveryServiceId" : 9
        } ]
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      }, {
        "trackCode" : "trackCode",
        "deliveryServiceId" : 9
      } ],
      "courier" : {
        "vehicleDescription" : "vehicleDescription",
        "phone" : "phone",
        "phoneExtension" : "phoneExtension",
        "fullName" : "fullName",
        "vehicleNumber" : "vehicleNumber"
      },
      "price" : 5.025004791520295,
      "outletStorageLimitDate" : "23-09-2022",
      "eacType" : "MERCHANT_TO_COURIER",
      "liftPrice" : 8.762042012749001,
      "eacCode" : "eacCode",
      "id" : "id",
      "region" : {
        "children" : [ null, null ],
        "name" : "name",
        "id" : 0,
        "type" : "OTHER"
      },
      "deliveryPartnerType" : "SHOP",
      "outletCode" : "outletCode"
    },
    "notes" : "notes",
    "substatus" : "RESERVATION_EXPIRED",
    "deliveryTotal" : 1.4658129805029452,
    "buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
    "creationDate" : "23-09-2022 09:12:41",
    "buyerItemsTotal" : 5.962133916683182,
    "paymentType" : "PREPAID",
    "buyer" : {
      "lastName" : "lastName",
      "firstName" : "firstName",
      "middleName" : "middleName",
      "id" : "id",
      "type" : "PERSON"
    },
    "expiryDate" : "23-09-2022 09:12:41",
    "buyerTotalBeforeDiscount" : 7.061401241503109,
    "itemsTotal" : 6.027456183070403,
    "buyerTotal" : 5.637376656633329,
    "subsidies" : [ {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    }, {
      "amount" : 4.965218492984954,
      "type" : "YANDEX_CASHBACK"
    } ],
    "paymentMethod" : "CASH_ON_DELIVERY",
    "currency" : "RUR",
    "fake" : true,
    "id" : 0,
    "taxSystem" : "OSN",
    "cancelRequested" : true,
    "items" : [ {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    }, {
      "offerName" : "offerName",
      "subsidy" : 1.0246457001441578,
      "instances" : [ {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      }, {
        "rnpt" : "rnpt",
        "gtd" : "gtd",
        "cisFull" : "cisFull",
        "uin" : "uin",
        "cis" : "cis"
      } ],
      "priceBeforeDiscount" : 7.386281948385884,
      "count" : 1,
      "vat" : "NO_VAT",
      "requiredInstanceTypes" : [ "CIS", "CIS" ],
      "buyerPriceBeforeDiscount" : 4.145608029883936,
      "shopSku" : "shopSku",
      "price" : 3.616076749251911,
      "partnerWarehouseId" : "partnerWarehouseId",
      "subsidies" : [ {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      }, {
        "amount" : 1.1730742509559433,
        "type" : "YANDEX_CASHBACK"
      } ],
      "offerId" : "offerId",
      "buyerPrice" : 2.027123023002322,
      "details" : [ {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      }, {
        "updateDate" : "23-09-2022",
        "itemStatus" : "REJECTED",
        "itemCount" : 7
      } ],
      "id" : 9,
      "promos" : [ {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      }, {
        "subsidy" : 6.84685269835264,
        "shopPromoId" : "shopPromoId",
        "discount" : 1.4894159098541704,
        "marketPromoId" : "marketPromoId",
        "type" : "DIRECT_DISCOUNT"
      } ]
    } ],
    "status" : "PLACING",
    "updatedAt" : "23-09-2022 09:12:41"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В случае успешного изменения статуса заказа возвращается обновленная информация о заказе. UpdateOrderStatusResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)

Изменяет статусы нескольких заказов.

Возможные изменения статусов:

Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOrderStatusesRequest UpdateOrderStatusesRequest (required)
Body Parameter

Return type

UpdateOrderStatusesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    }, {
      "substatus" : "RESERVATION_EXPIRED",
      "updateStatus" : "OK",
      "id" : 0,
      "status" : "PLACING",
      "errorDetails" : "errorDetails"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возвращается информация об обновленных статусах заказов. UpdateOrderStatusesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OrdersStats

Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)

Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.

{% note info "" %}

Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете

{% endnote %}

В одном запросе можно получить информацию не более чем по 200 заказам.

|⚙️ Лимит: 1 000 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetOrdersStatsRequest GetOrdersStatsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetOrdersStatsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orders" : [ {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    }, {
      "partnerOrderId" : "partnerOrderId",
      "commissions" : [ {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      }, {
        "actual" : 1.2315135367772556,
        "type" : "FEE"
      } ],
      "statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
      "payments" : [ {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      }, {
        "date" : "2000-01-23",
        "total" : 7.386281948385884,
        "paymentOrder" : {
          "date" : "2000-01-23",
          "id" : "id"
        },
        "id" : "id",
        "source" : "BUYER",
        "type" : "PAYMENT"
      } ],
      "fake" : true,
      "deliveryRegion" : {
        "name" : "name",
        "id" : 6
      },
      "id" : 0,
      "creationDate" : "2000-01-23",
      "items" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "initialItems" : [ {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      }, {
        "cofinanceValue" : 4.145608029883936,
        "initialCount" : 3,
        "offerName" : "offerName",
        "shopSku" : "shopSku",
        "cisList" : [ "cisList", "cisList" ],
        "marketSku" : 1,
        "count" : 5,
        "bidFee" : 570,
        "cofinanceThreshold" : 2.027123023002322,
        "details" : [ {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        }, {
          "updateDate" : "2000-01-23",
          "stockType" : "FIT",
          "itemStatus" : "REJECTED",
          "itemCount" : 9
        } ],
        "prices" : [ {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        }, {
          "total" : 2.3021358869347655,
          "costPerItem" : 5.637376656633329,
          "type" : "BUYER"
        } ],
        "warehouse" : {
          "name" : "name",
          "id" : 7
        }
      } ],
      "status" : "CANCELLED_BEFORE_PROCESSING",
      "paymentType" : "CREDIT"
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по заказам. GetOrdersStatsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

OutletLicenses

Up
delete /campaigns/{campaignId}/outlets/licenses
Удаление лицензий для точек продаж (deleteOutletLicenses)

Удаляет информацию о лицензиях для точек продаж.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets/licenses
Информация о лицензиях для точек продаж (getOutletLicenses)

Возвращает информацию о лицензиях для точек продаж.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

outletIds (optional)
Query Parameter

Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.

default: null format: int64
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64

Return type

GetOutletLicensesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "licenses" : [ {
      "licenseType" : "ALCOHOL",
      "number" : "number",
      "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
      "checkStatus" : "NEW",
      "outletId" : 6,
      "id" : 0,
      "dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
      "checkComment" : "checkComment"
    }, {
      "licenseType" : "ALCOHOL",
      "number" : "number",
      "dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
      "checkStatus" : "NEW",
      "outletId" : 6,
      "id" : 0,
      "dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
      "checkComment" : "checkComment"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденные лицензии собственных точек продаж. GetOutletLicensesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/outlets/licenses
Создание и изменение лицензий для точек продаж (updateOutletLicenses)

Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя.

Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateOutletLicenseRequest UpdateOutletLicenseRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Outlets

Up
post /campaigns/{campaignId}/outlets
Создание точки продаж (createOutlet)

Создает точку продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ChangeOutletRequest ChangeOutletRequest (required)
Body Parameter

Return type

CreateOutletResponse

Example data

Content-Type: application/json
{
  "result" : {
    "id" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о созданной точке продаж. CreateOutletResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
delete /campaigns/{campaignId}/outlets/{outletId}
Удаление точки продаж (deleteOutlet)

Удаляет точку продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets/{outletId}
Информация об одной точке продаж (getOutlet)

Возвращает информацию о точках продаж магазина.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Return type

GetOutletResponse

Example data

Content-Type: application/json
{
  "outlet" : {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о точке продаж. GetOutletResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/outlets
Информация о нескольких точках продаж (getOutlets)

Возвращает список точек продаж магазина.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
region_id (optional)
Query Parameter — Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода GET regions. default: null format: int64
shop_outlet_code (optional)
Query Parameter — Идентификатор точки продаж, присвоенный магазином. default: null
regionId (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Для указания региона используйте region_id.

{% endnote %}

default: null format: int64

Return type

GetOutletsResponse

Example data

Content-Type: application/json
{
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  },
  "outlets" : [ {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  }, {
    "storagePeriod" : 9,
    "address" : {
      "number" : "number",
      "km" : 6,
      "regionId" : 0,
      "city" : "city",
      "street" : "street",
      "additional" : "additional",
      "estate" : "estate",
      "block" : "block",
      "building" : "building"
    },
    "moderationReason" : "moderationReason",
    "visibility" : "HIDDEN",
    "isMain" : true,
    "phones" : [ "phones", "phones" ],
    "workingTime" : "workingTime",
    "type" : "DEPOT",
    "workingSchedule" : {
      "scheduleItems" : [ {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      }, {
        "startDay" : "MONDAY",
        "startTime" : "startTime",
        "endTime" : "endTime"
      } ],
      "workInHoliday" : true
    },
    "shopOutletId" : "shopOutletId",
    "shopOutletCode" : "shopOutletCode",
    "name" : "name",
    "id" : 3,
    "region" : {
      "children" : [ null, null ],
      "name" : "name",
      "id" : 0,
      "type" : "OTHER"
    },
    "coords" : "coords",
    "deliveryRules" : [ {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    }, {
      "priceFreePickup" : 7.061401241503109,
      "deliveryServiceId" : 5,
      "maxDeliveryDays" : 5,
      "minDeliveryDays" : 1,
      "orderBefore" : 5,
      "unspecifiedDeliveryInterval" : true
    } ],
    "status" : "AT_MODERATION"
  } ],
  "paging" : {
    "prevPageToken" : "prevPageToken",
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о точках продаж. GetOutletsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/outlets/{outletId}
Изменение информации о точке продаж (updateOutlet)

Изменяет информацию о точке продаж магазина на Маркете.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

|⚙️ Лимит: 100 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ChangeOutletRequest ChangeOutletRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

PriceQuarantine

Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)

Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.

Основная цена задается в каталоге и действует во всех магазинах кабинета.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)

Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.

Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин

Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmPricesRequest ConfirmPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ответ 200 обозначает, что цены подтверждены. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)

Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

{% note info "𝓠 Что такое карантин?" %}

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

{% endnote %}

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQuarantineOffersRequest GetQuarantineOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetQuarantineOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    }, {
      "verdicts" : [ {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      }, {
        "type" : "PRICE_CHANGE",
        "params" : [ {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        }, {
          "name" : "CURRENT_PRICE",
          "value" : "value"
        } ]
      } ],
      "offerId" : "offerId",
      "currentPrice" : {
        "value" : 0.9301444243932576
      },
      "lastValidPrice" : {
        "value" : 0.9301444243932576
      }
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров в карантине. GetQuarantineOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Prices

Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.

{% endnote %}

Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.

{% note info %}

Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.

{% endnote %}

Способы установки цен описаны в Справке Маркета для продавцов.

|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false

Return type

GetPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "marketSku" : 0,
      "id" : "id",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "total" : 6,
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список всех товаров с установленными ценами. GetPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)

Возвращает список цен на указанные товары в магазине.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

{% endnote %}

|⚙️ Лимит: рассчитывается по формуле| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPricesByOfferIdsRequest GetPricesByOfferIdsRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPricesByOfferIdsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "price" : {
        "vat" : 1,
        "discountBase" : 6.027456183070403,
        "currencyId" : "RUR",
        "value" : 0.8008281904610115
      },
      "offerId" : "offerId",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров с установленными для заданного магазина ценами. GetPricesByOfferIdsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)

{% note warning "" %}

Этот метод устарел. Вместо него используйте отчет «Цены на рынке».

{% endnote %}

{% note warning "" %}

Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.

{% endnote %}

Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.

Товары, для которых нужно получить цены, передаются в теле POST-запроса.

Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.

Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.

Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.

Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.

|⚙️ Лимит: 100 000 товаров в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SuggestPricesRequest SuggestPricesRequest (required)
Body Parameter

Return type

SuggestPricesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    }, {
      "marketSku" : 0,
      "offerId" : "offerId",
      "priceSuggestion" : [ {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      }, {
        "price" : 6.027456183070403,
        "type" : "BUYBOX"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список цен для продвижения на Маркете. SuggestPricesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)

Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateBusinessPricesRequest UpdateBusinessPricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)

Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.

{% note warning "Метод только для отдельных магазинов" %}

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.

{% endnote %}

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 5000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePricesRequest UpdatePricesRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Маркет принял информацию о новых ценах. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

423

К ресурсу нельзя применить указанный метод. ApiLockedErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Promos

Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)

Убирает товары из акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DeletePromoOffersRequest DeletePromoOffersRequest (required)
Body Parameter

Return type

DeletePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат удаления товаров из акции. DeletePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)

Возвращает список товаров, которые участвуют или могут участвовать в акции.

{% note warning %}

В параметре limit не передавайте значение больше 500.

{% endnote %}

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromoOffersRequest GetPromoOffersRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetPromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    }, {
      "offerId" : "offerId",
      "params" : {
        "discountParams" : {
          "promoPrice" : 6,
          "maxPromoPrice" : 1,
          "price" : 0
        },
        "promocodeParams" : {
          "maxPrice" : 5
        }
      },
      "status" : "AUTO",
      "autoParticipatingDetails" : {
        "campaignIds" : [ 5, 5 ]
      }
    } ],
    "paging" : {
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список товаров, которые участвуют или могут участвовать в акции. GetPromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)

Возвращает информацию об акциях Маркета.

По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

|⚙️ Лимит: 1000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetPromosRequest GetPromosRequest (optional)
Body Parameter

Return type

GetPromosResponse

Example data

Content-Type: application/json
{
  "result" : {
    "promos" : [ {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    }, {
      "period" : {
        "dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
        "dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
      },
      "channels" : [ "{}", "{}" ],
      "mechanicsInfo" : {
        "promocodeInfo" : {
          "promocode" : "promocode",
          "discount" : 1
        },
        "type" : "DIRECT_DISCOUNT"
      },
      "bestsellerInfo" : {
        "bestseller" : true,
        "entryDeadline" : "2000-01-23T04:56:07.000+00:00"
      },
      "name" : "name",
      "participating" : true,
      "id" : "id",
      "constraints" : {
        "warehouseIds" : [ 5, 5 ]
      },
      "assortmentInfo" : {
        "activeOffers" : 0,
        "processing" : true,
        "potentialOffers" : 6
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список акций Маркета. GetPromosResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)

Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.

Изменения начинают действовать в течение 4–6 часов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdatePromoOffersRequest UpdatePromoOffersRequest (required)
Body Parameter

Return type

UpdatePromoOffersResponse

Example data

Content-Type: application/json
{
  "result" : {
    "rejectedOffers" : [ {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    }, {
      "reason" : "OFFER_DOES_NOT_EXIST",
      "offerId" : "offerId"
    } ],
    "warningOffers" : [ {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    }, {
      "warnings" : [ {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      }, {
        "code" : "DEEP_DISCOUNT_OFFER",
        "campaignIds" : [ 0, 0 ]
      } ],
      "offerId" : "offerId"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Результат добавления товаров в акцию или обновления их цен. UpdatePromoOffersResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Ratings

Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос POST businesses/{businessId}/ratings/quality.

|⚙️ Лимит: 100000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetQualityRatingDetailsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "affectedOrders" : [ {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    }, {
      "componentType" : "DBS_CANCELLATION_RATE",
      "orderId" : 0,
      "description" : "description"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация о заказах, которые повлияли на индекс качества. GetQualityRatingDetailsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

|⚙️ Лимит: 10000 запросов в час| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetQualityRatingRequest GetQualityRatingRequest (required)
Body Parameter

Return type

GetQualityRatingResponse

Example data

Content-Type: application/json
{
  "result" : {
    "campaignRatings" : [ {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    }, {
      "campaignId" : 0,
      "ratings" : [ {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      }, {
        "components" : [ {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        }, {
          "componentType" : "DBS_CANCELLATION_RATE",
          "value" : 14.658129805029452
        } ],
        "rating" : 60,
        "calculationDate" : "2000-01-23"
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Значение индекса качества магазинов и его составляющие. GetQualityRatingResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Regions

Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Query parameters

page (optional)
Query Parameter

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

default: 1 format: int32
pageSize (optional)
Query Parameter

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

default: null format: int32

Return type

GetRegionWithChildrenResponse

Example data

Content-Type: application/json
{
  "regions" : {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  },
  "pager" : {
    "total" : 1,
    "pagesCount" : 7,
    "pageSize" : 9,
    "from" : 5,
    "to" : 5,
    "currentPage" : 2
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Регионы, являющиеся дочерними к указанному в запросе. GetRegionWithChildrenResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)

Возвращает информацию о регионе.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Path parameters

regionId (required)
Path Parameter

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

default: null format: int64

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденный регион. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /regions
Поиск регионов по их имени (searchRegionsByName)

Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

|⚙️ Лимит: 50 000 запросов в час| |-|

Query parameters

name (required)
Query Parameter

Название региона.

Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.

default: null
page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetRegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  }, {
    "children" : [ null, null ],
    "name" : "name",
    "id" : 0,
    "type" : "OTHER"
  } ],
  "paging" : {
    "nextPageToken" : "nextPageToken"
  }
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список найденных регионов. GetRegionsResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Reports

Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)

Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateBoostConsolidatedRequest GenerateBoostConsolidatedRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)

Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

{% note info "Значение -1 в отчете" %}

Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.

{% endnote %}

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateCompetitorsPositionReportRequest GenerateCompetitorsPositionReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)

Запускает генерацию отчета по отзывам о товарах. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsFeedbackRequest GenerateGoodsFeedbackRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-movement/generate
Отчет по движению товаров (generateGoodsMovementReport)

Запускает генерацию отчета по движению товаров. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsMovementReportRequest GenerateGoodsMovementReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)

Запускает генерацию отчета по реализации за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsRealizationReportRequest GenerateGoodsRealizationReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/goods-turnover/generate
Отчет по оборачиваемости (generateGoodsTurnoverReport)

Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateGoodsTurnoverRequest GenerateGoodsTurnoverRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 1000 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateMassOrderLabelsRequest GenerateMassOrderLabelsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)

Запускает генерацию отчета «Цены на рынке».

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GeneratePricesReportRequest GeneratePricesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)

Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShelfsStatisticsRequest GenerateShelfsStatisticsRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/documents/shipment-list/generate
Получение листа сборки (generateShipmentListDocumentReport)

Запускает генерацию листа сборки для отгрузки.

Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShipmentListDocumentReportRequest GenerateShipmentListDocumentReportRequest (required)
Body Parameter

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый документ. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 10 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateShowsSalesReportRequest GenerateShowsSalesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateStocksOnWarehousesReportRequest GenerateStocksOnWarehousesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-----------------------------|---------------------------------| |По дате начисления услуги |dateFrom и dateTo | |По дате формирования акта |year и month |

Заказать отчеты обоих типов одним запросом нельзя.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedMarketplaceServicesReportRequest GenerateUnitedMarketplaceServicesReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)

Запускает генерацию отчета по платежам за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Тип отчета зависит от того, какие поля заполнены в запросе:

|Тип отчета |Какие поля нужны | |-------------------------|---------------------------------------| |О платежах за период |dateFrom и dateTo | |О платежном поручении |bankOrderId и bankOrderDateTime |

Заказать отчеты обоих типов одним запросом нельзя.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedNettingReportRequest GenerateUnitedNettingReportRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)

Запускает генерацию отчета по заказам за заданный период. Что это за отчет

{% note info "" %}

Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам

{% endnote %}

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

|⚙️ Лимит: 100 запросов в час| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GenerateUnitedOrdersRequest GenerateUnitedOrdersRequest (required)
Body Parameter

Query parameters

format (optional)
Query Parameter — Формат отчета. default: null

Return type

GenerateReportResponse

Example data

Content-Type: application/json
{
  "result" : {
    "reportId" : "reportId",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет. GenerateReportResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null

Return type

GetReportInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
    "file" : "file",
    "generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
    "subStatus" : "NO_DATA",
    "status" : "PENDING",
    "estimatedGenerationTime" : 0
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус генерации отчета и ссылка, если она уже есть.

{% note tip %}

Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.

{% endnote %}

 

GetReportInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Returns

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)

Получает информацию по одному невыкупу или возврату.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

GetReturnResponse

Example data

Content-Type: application/json
{
  "result" : {
    "updateDate" : "2000-01-23T04:56:07.000+00:00",
    "fastReturn" : true,
    "orderId" : 6,
    "shipmentRecipientType" : "SHOP",
    "refundStatus" : "STARTED_BY_USER",
    "logisticPickupPoint" : {
      "logisticPartnerId" : 5,
      "address" : {
        "country" : "Россия",
        "city" : "Москва",
        "street" : "Стрелецкая улица",
        "postcode" : "123518",
        "house" : "9к2"
      },
      "instruction" : "instruction",
      "name" : "name",
      "id" : 1,
      "type" : "WAREHOUSE"
    },
    "id" : 0,
    "creationDate" : "2000-01-23T04:56:07.000+00:00",
    "items" : [ {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    }, {
      "shopSku" : "shopSku",
      "instances" : [ {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      }, {
        "stockType" : "FIT",
        "imei" : "imei",
        "cis" : "cis",
        "status" : "CREATED"
      } ],
      "marketSku" : 2,
      "count" : 7,
      "decisions" : [ {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      }, {
        "images" : [ "images", "images" ],
        "returnItemId" : 9,
        "subreasonType" : "USER_DID_NOT_LIKE",
        "count" : 3,
        "comment" : "comment",
        "decisionType" : "REFUND_MONEY",
        "reasonType" : "BAD_QUALITY",
        "partnerCompensation" : 4,
        "refundAmount" : 2
      } ],
      "tracks" : [ {
        "trackCode" : "trackCode"
      }, {
        "trackCode" : "trackCode"
      } ]
    } ],
    "returnType" : "UNREDEEMED",
    "shipmentStatus" : "CREATED",
    "refundAmount" : 5
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. GetReturnResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)

Загружает заявление покупателя на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Заявление на возврат. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)

Получает фотографии, которые покупатель приложил к заявлению на возврат товара.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Фотография возврата. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)

Получает список невыкупов и возвратов.

Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter

Идентификаторы заказов — для фильтрации результатов.

Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.

default: null format: int64
statuses (optional)
Query Parameter

Статусы возвратов или невыкупов — для фильтрации результатов.

Несколько статусов перечисляются через запятую.

default: null
type (optional)
Query Parameter

Тип заказа для фильтрации:

  • RETURN — возврат.

  • UNREDEEMED — невыкуп.

Если не указывать, в ответе будут и возвраты, и невыкупы.

default: null
fromDate (optional)
Query Parameter

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
toDate (optional)
Query Parameter

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

Формат: ГГГГ-ММ-ДД.

default: null format: date
from_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте fromDate.

{% endnote %}

Начальная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date
to_date (optional)
Query Parameter

{% note warning "" %}

Этот параметр устарел. Вместо него используйте toDate.

{% endnote %}

Конечная дата для фильтрации возвратов или невыкупов по дате обновления.

default: null format: date

Return type

GetReturnsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "returns" : [ {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    }, {
      "updateDate" : "2000-01-23T04:56:07.000+00:00",
      "fastReturn" : true,
      "orderId" : 6,
      "shipmentRecipientType" : "SHOP",
      "refundStatus" : "STARTED_BY_USER",
      "logisticPickupPoint" : {
        "logisticPartnerId" : 5,
        "address" : {
          "country" : "Россия",
          "city" : "Москва",
          "street" : "Стрелецкая улица",
          "postcode" : "123518",
          "house" : "9к2"
        },
        "instruction" : "instruction",
        "name" : "name",
        "id" : 1,
        "type" : "WAREHOUSE"
      },
      "id" : 0,
      "creationDate" : "2000-01-23T04:56:07.000+00:00",
      "items" : [ {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      }, {
        "shopSku" : "shopSku",
        "instances" : [ {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        }, {
          "stockType" : "FIT",
          "imei" : "imei",
          "cis" : "cis",
          "status" : "CREATED"
        } ],
        "marketSku" : 2,
        "count" : 7,
        "decisions" : [ {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        }, {
          "images" : [ "images", "images" ],
          "returnItemId" : 9,
          "subreasonType" : "USER_DID_NOT_LIKE",
          "count" : 3,
          "comment" : "comment",
          "decisionType" : "REFUND_MONEY",
          "reasonType" : "BAD_QUALITY",
          "partnerCompensation" : 4,
          "refundAmount" : 2
        } ],
        "tracks" : [ {
          "trackCode" : "trackCode"
        }, {
          "trackCode" : "trackCode"
        } ]
      } ],
      "returnType" : "UNREDEEMED",
      "shipmentStatus" : "CREATED",
      "refundAmount" : 5
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Постраничные возвраты партнера. GetReturnsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision
Принятие или изменение решения по возврату (setReturnDecision)

Выбирает решение по возврату от покупателя. После этого для подтверждения решения нужно выполнить запрос POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetReturnDecisionRequest SetReturnDecisionRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Детали возврата. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit
Подтверждение решения по возврату (submitReturnDecision)

Подтверждает выбранное решение по возврату, отправленное в запросе POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision.

|⚙️ Лимит: 10 000 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Статус выполнения операции. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Shipments

Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm
Подтверждение отгрузки (confirmShipment)
Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConfirmShipmentRequest ConfirmShipmentRequest (optional)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act
Получение акта приема-передачи (downloadShipmentAct)

{% note warning "Экспресс‑доставка" %}

Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.

{% endnote %}

Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы.

При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:

{% cut "Данные, из которых Маркет формирует акт" %}

| Данные в акте | Описание | | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Дата | Дата запроса. | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |

{% endcut %}

Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт приема-передачи для отгрузки в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act
Получение акта расхождений (downloadShipmentDiscrepancyAct)
Возвращает акт расхождений для заданной отгрузки. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт расхождений в формате XLSX. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act
Получение фактического акта приема-передачи (downloadShipmentInboundAct)

Возвращает фактический акт приема-передачи для заданной отгрузки.

Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения.

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels
Ярлыки для доверительной приемки (FBS) (downloadShipmentPalletLabels)

PDF-файл с ярлыками на каждый короб или палету в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета.

Распечатайте по несколько копий каждого ярлыка: на одну тару нужно наклеить минимум 2 ярлыка с разных сторон.

Количество упаковок в отгрузке задается в запросе PUT campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Query parameters

format (optional)
Query Parameter

Формат страниц PDF-файла с ярлыками:

  • A4 — по 16 ярлыков на странице.
  • A8 — по одному ярлыку на странице.
default: null

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PDF‑файл с ярлыками на все упаковки в отгрузке. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/shipments/reception-transfer-act
Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее (downloadShipmentReceptionTransferAct)

Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF.

{% note warning "Экспресс‑доставка" %}

Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.

{% endnote %}

В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета.

При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:

{% cut "Данные, из которых Маркет формирует акт" %}

| Данные в акте | Описание | | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |

{% endcut %}

Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Query parameters

warehouse_id (optional)
Query Parameter — Идентификатор склада. default: null format: int32

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Акт приема-передачи в формате PDF. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill
Получение транспортной накладной (downloadShipmentTransportationWaybill)

Возвращает транспортную накладную для заданной отгрузки.

Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. Подробно об этом способе отгрузки

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

File

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Транспортная накладная в формате XLSX. File

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Получение информации об одной отгрузке (getShipment)
Возвращает информацию об отгрузке по ее идентификатору. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Query parameters

cancelledOrders (optional)
Query Parameter

Возвращать ли отмененные заказы.

Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.

default: true

Return type

GetShipmentResponse

Example data

Content-Type: application/json
{
  "result" : {
    "deliveryService" : {
      "name" : "name",
      "id" : 1
    },
    "availableActions" : [ "CONFIRM", "CONFIRM" ],
    "draftCount" : 7,
    "plannedCount" : 9,
    "currentStatus" : {
      "description" : "description",
      "updateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    },
    "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
    "externalId" : "externalId",
    "warehouse" : {
      "address" : "address",
      "name" : "name",
      "id" : 6
    },
    "shipmentType" : "IMPORT",
    "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
    "warehouseTo" : {
      "address" : "address",
      "name" : "name",
      "id" : 6
    },
    "factCount" : 3,
    "palletsCount" : {
      "fact" : 5,
      "planned" : 5
    },
    "id" : 0,
    "orderIds" : [ 2, 2 ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденная отгрузка. GetShipmentResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info
Получение информации о возможности печати ярлыков (FBS) (getShipmentOrdersInfo)
Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Return type

GetShipmentOrdersInfoResponse

Example data

Content-Type: application/json
{
  "result" : {
    "orderIdsWithLabels" : [ 0, 0 ],
    "orderIdsWithoutLabels" : [ 6, 6 ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по годным/негодным для печати ярлыков заказам в отгрузке. GetShipmentOrdersInfoResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/first-mile/shipments
Получение информации о нескольких отгрузках (searchShipments)

Возвращает информацию об отгрузках по заданным параметрам:

Результаты возвращаются постранично. |⚙️ Лимит: 100 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SearchShipmentsRequest SearchShipmentsRequest (required)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

SearchShipmentsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "paging" : {
      "nextPageToken" : "nextPageToken"
    },
    "shipments" : [ {
      "deliveryService" : {
        "name" : "name",
        "id" : 1
      },
      "draftCount" : 1,
      "plannedCount" : 5,
      "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
      "externalId" : "externalId",
      "warehouse" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "shipmentType" : "IMPORT",
      "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
      "statusDescription" : "statusDescription",
      "warehouseTo" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "factCount" : 5,
      "palletsCount" : {
        "fact" : 5,
        "planned" : 5
      },
      "id" : 0,
      "orderIds" : [ 6, 6 ],
      "statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    }, {
      "deliveryService" : {
        "name" : "name",
        "id" : 1
      },
      "draftCount" : 1,
      "plannedCount" : 5,
      "planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
      "externalId" : "externalId",
      "warehouse" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "shipmentType" : "IMPORT",
      "planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
      "statusDescription" : "statusDescription",
      "warehouseTo" : {
        "address" : "address",
        "name" : "name",
        "id" : 6
      },
      "factCount" : 5,
      "palletsCount" : {
        "fact" : 5,
        "planned" : 5
      },
      "id" : 0,
      "orderIds" : [ 6, 6 ],
      "statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
      "status" : "OUTBOUND_CREATED"
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Найденные отгрузки. SearchShipmentsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets
Передача количества упаковок в отгрузке (setShipmentPalletsCount)

Передает Маркету количество коробов или палет в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета.

Получить PDF-файл с ярлыками для упаковок можно с помощью запроса GET campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels. |⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SetShipmentPalletsCountRequest SetShipmentPalletsCountRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Имеет значение только тип ответа. Если ответ ОК, количество упаковок записано. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer
Перенос заказов в следующую отгрузку (transferOrdersFromShipment)

Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка?

Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя.

{% note warning "Такие переносы снижают индекс качества магазина" %}

Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения?

{% endnote %}

Переносить заказы можно, если до формирования отгрузки осталось больше получаса.

Перенос происходит не мгновенно, а занимает несколько минут.

|⚙️ Лимит: 200 запросов в час| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TransferOrdersFromShipmentRequest TransferOrdersFromShipmentRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Запрос на перенос заказов проверен и принят, и они будут перенесены спустя несколько минут. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Stocks

Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)

Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).

{% note info "По умолчанию данные по оборачивамости не возращаются" %}

Чтобы они были в ответе, передавайте true в поле withTurnover.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

GetWarehouseStocksRequest GetWarehouseStocksRequest (optional)
Body Parameter

Query parameters

page_token (optional)
Query Parameter

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.

default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32

Return type

GetWarehouseStocksResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    }, {
      "offers" : [ {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      }, {
        "offerId" : "offerId",
        "turnoverSummary" : {
          "turnoverDays" : 6.027456183070403,
          "turnover" : "LOW"
        },
        "stocks" : [ {
          "count" : 1,
          "type" : "FIT"
        }, {
          "count" : 1,
          "type" : "FIT"
        } ],
        "updatedAt" : "2000-01-23T04:56:07.000+00:00"
      } ],
      "warehouseId" : 0
    } ],
    "paging" : {
      "prevPageToken" : "prevPageToken",
      "nextPageToken" : "nextPageToken"
    }
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Остатки товаров на складах. GetWarehouseStocksResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)

Передает данные об остатках товаров на витрине.

Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.

{% note info "Данные в каталоге обновляются не мгновенно" %}

Это занимает до нескольких минут.

{% endnote %}

|⚙️ Лимит: 100 000 товаров в минуту| |-|

Path parameters

campaignId (required)
Path Parameter

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UpdateStocksRequest UpdateStocksRequest (required)
Body Parameter

Return type

EmptyApiResponse

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Пустой ответ. EmptyApiResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Tariffs

Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

|⚙️ Лимит: 100 запросов в минуту| |-|

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CalculateTariffsRequest CalculateTariffsRequest (required)
Body Parameter

Return type

CalculateTariffsResponse

Example data

Content-Type: application/json
{
  "result" : {
    "offers" : [ {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    }, {
      "offer" : {
        "quantity" : 1,
        "price" : 0.6027456183070403,
        "length" : 0.14658129805029452,
        "width" : 0.5962133916683182,
        "weight" : 0.23021358869347652,
        "categoryId" : 0,
        "height" : 0.5637376656633328
      },
      "tariffs" : [ {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      }, {
        "amount" : 9.301444243932576,
        "type" : "AGENCY_COMMISSION",
        "parameters" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ]
      } ]
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Стоимость услуг. CalculateTariffsResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Warehouses

Up
get /warehouses
Идентификаторы складов Маркета (FBY) (getFulfillmentWarehouses)

Возвращает список складов Маркета с их идентификаторами.

|⚙️ Лимит: 100 запросов в минуту| |-|

Return type

GetFulfillmentWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "name" : "name",
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "name" : "name",
      "id" : 0
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов. GetFulfillmentWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)

Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны

Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.

|⚙️ Лимит: 100 запросов в минуту| |-|

Path parameters

businessId (required)
Path Parameter

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

default: null format: int64

Return type

GetWarehousesResponse

Example data

Content-Type: application/json
{
  "result" : {
    "warehouses" : [ {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    }, {
      "address" : {
        "number" : "number",
        "city" : "city",
        "street" : "street",
        "block" : "block",
        "gps" : {
          "latitude" : 9.965781217890562,
          "longitude" : 9.369310271410669
        },
        "building" : "building"
      },
      "campaignId" : 6,
      "name" : "name",
      "express" : true,
      "id" : 0
    } ],
    "warehouseGroups" : [ {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    }, {
      "name" : "name",
      "warehouses" : [ {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }, {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      } ],
      "mainWarehouse" : {
        "address" : {
          "number" : "number",
          "city" : "city",
          "street" : "street",
          "block" : "block",
          "gps" : {
            "latitude" : 9.965781217890562,
            "longitude" : 9.369310271410669
          },
          "building" : "building"
        },
        "campaignId" : 6,
        "name" : "name",
        "express" : true,
        "id" : 0
      }
    } ]
  },
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Example data

Content-Type: application/json
{
  "errors" : [ {
    "code" : "code",
    "message" : "message"
  }, {
    "code" : "code",
    "message" : "message"
  } ],
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список складов и групп складов. GetWarehousesResponse

400

Запрос содержит неправильные данные. ApiClientDataErrorResponse

401

В запросе не указаны данные для авторизации. ApiUnauthorizedErrorResponse

403

Данные для авторизации неверны или доступ к ресурсу запрещен. ApiForbiddenErrorResponse

404

Запрашиваемый ресурс не найден. ApiNotFoundErrorResponse

420

Превышено ограничение на доступ к ресурсу. ApiLimitErrorResponse

500

Внутренняя ошибка сервера. ApiServerErrorResponse

Models

[ Jump to Methods ]

Table of Contents

  1. AcceptOrderCancellationRequest -
  2. AddHiddenOffersRequest -
  3. AddOffersToArchiveDTO -
  4. AddOffersToArchiveErrorDTO -
  5. AddOffersToArchiveErrorType -
  6. AddOffersToArchiveRequest -
  7. AddOffersToArchiveResponse -
  8. AffectedOrderQualityRatingComponentType -
  9. AgeDTO -
  10. AgeUnitType -
  11. ApiClientDataErrorResponse -
  12. ApiErrorDTO -
  13. ApiErrorResponse -
  14. ApiForbiddenErrorResponse -
  15. ApiLimitErrorResponse -
  16. ApiLockedErrorResponse -
  17. ApiNotFoundErrorResponse -
  18. ApiResponse -
  19. ApiResponseStatusType -
  20. ApiServerErrorResponse -
  21. ApiUnauthorizedErrorResponse -
  22. BaseCampaignOfferDTO -
  23. BaseOfferDTO -
  24. BasePriceDTO -
  25. BaseShipmentDTO -
  26. BidRecommendationItemDTO -
  27. BriefOrderItemDTO -
  28. BriefOrderItemInstanceDTO -
  29. BusinessDTO -
  30. BusinessSettingsDTO -
  31. CalculateTariffsOfferDTO -
  32. CalculateTariffsOfferInfoDTO -
  33. CalculateTariffsParametersDTO -
  34. CalculateTariffsRequest -
  35. CalculateTariffsResponse -
  36. CalculateTariffsResponseDTO -
  37. CalculatedTariffDTO -
  38. CalculatedTariffType -
  39. CampaignDTO -
  40. CampaignQualityRatingDTO -
  41. CampaignSettingsDTO -
  42. CampaignSettingsDeliveryDTO -
  43. CampaignSettingsLocalRegionDTO -
  44. CampaignSettingsScheduleDTO -
  45. CampaignSettingsScheduleSourceType -
  46. CampaignSettingsTimePeriodDTO -
  47. CampaignsQualityRatingDTO -
  48. CategoryContentParametersDTO -
  49. CategoryDTO -
  50. CategoryErrorDTO -
  51. CategoryErrorType -
  52. CategoryParameterDTO -
  53. CategoryParameterUnitDTO -
  54. ChangeOutletRequest -
  55. ChannelType -
  56. ChatMessageDTO -
  57. ChatMessagePayloadDTO -
  58. ChatMessageSenderType -
  59. ChatMessagesResultDTO -
  60. ChatStatusType -
  61. ChatType -
  62. ConfirmPricesRequest -
  63. ConfirmShipmentRequest -
  64. CreateChatRequest -
  65. CreateChatResponse -
  66. CreateChatResultDTO -
  67. CreateOutletResponse -
  68. CurrencyType -
  69. DayOfWeekType -
  70. DeleteCampaignOffersDTO -
  71. DeleteCampaignOffersRequest -
  72. DeleteCampaignOffersResponse -
  73. DeleteGoodsFeedbackCommentRequest -
  74. DeleteHiddenOffersRequest -
  75. DeleteOffersDTO -
  76. DeleteOffersFromArchiveDTO -
  77. DeleteOffersFromArchiveRequest -
  78. DeleteOffersFromArchiveResponse -
  79. DeleteOffersRequest -
  80. DeleteOffersResponse -
  81. DeletePromoOffersRequest -
  82. DeletePromoOffersResponse -
  83. DeletePromoOffersResultDTO -
  84. DeliveryServiceDTO -
  85. DeliveryServiceInfoDTO -
  86. DeliveryServicesDTO -
  87. DocumentDTO -
  88. EacVerificationResultDTO -
  89. EacVerificationStatusType -
  90. EmptyApiResponse -
  91. EnrichedMappingsOfferDTO -
  92. EnrichedModelDTO -
  93. EnrichedModelsDTO -
  94. EnrichedOrderBoxLayoutDTO -
  95. ExtensionShipmentDTO -
  96. FeedContentDTO -
  97. FeedContentErrorDTO -
  98. FeedContentErrorType -
  99. FeedDTO -
  100. FeedDownloadDTO -
  101. FeedDownloadErrorDTO -
  102. FeedDownloadErrorType -
  103. FeedIndexLogsErrorDTO -
  104. FeedIndexLogsErrorType -
  105. FeedIndexLogsFeedDTO -
  106. FeedIndexLogsIndexType -
  107. FeedIndexLogsOffersDTO -
  108. FeedIndexLogsRecordDTO -
  109. FeedIndexLogsResultDTO -
  110. FeedIndexLogsStatusType -
  111. FeedParameterDTO -
  112. FeedPlacementDTO -
  113. FeedPublicationDTO -
  114. FeedPublicationFullDTO -
  115. FeedPublicationPriceAndStockUpdateDTO -
  116. FeedStatusType -
  117. FeedbackAuthorDTO -
  118. FeedbackCommentAuthorDTO -
  119. FeedbackCommentAuthorType -
  120. FeedbackCommentDTO -
  121. FeedbackDTO -
  122. FeedbackDeliveryType -
  123. FeedbackFactorDTO -
  124. FeedbackGradesDTO -
  125. FeedbackListDTO -
  126. FeedbackOrderDTO -
  127. FeedbackReactionStatusType -
  128. FeedbackShopDTO -
  129. FeedbackStateType -
  130. FieldStateType -
  131. FlippingPagerDTO -
  132. ForwardScrollingPagerDTO -
  133. FulfillmentWarehouseDTO -
  134. FulfillmentWarehousesDTO -
  135. FullOutletDTO -
  136. FullOutletLicenseDTO -
  137. GenerateBoostConsolidatedRequest -
  138. GenerateCompetitorsPositionReportRequest -
  139. GenerateGoodsFeedbackRequest -
  140. GenerateGoodsMovementReportRequest -
  141. GenerateGoodsRealizationReportRequest -
  142. GenerateGoodsTurnoverRequest -
  143. GenerateMassOrderLabelsRequest -
  144. GeneratePricesReportRequest -
  145. GenerateReportDTO -
  146. GenerateReportResponse -
  147. GenerateShelfsStatisticsRequest -
  148. GenerateShipmentListDocumentReportRequest -
  149. GenerateShowsSalesReportRequest -
  150. GenerateStocksOnWarehousesReportRequest -
  151. GenerateUnitedMarketplaceServicesReportRequest -
  152. GenerateUnitedNettingReportRequest -
  153. GenerateUnitedOrdersRequest -
  154. GetAllOffersResponse -
  155. GetBidsInfoRequest -
  156. GetBidsInfoResponse -
  157. GetBidsInfoResponseDTO -
  158. GetBidsRecommendationsRequest -
  159. GetBidsRecommendationsResponse -
  160. GetBidsRecommendationsResponseDTO -
  161. GetBusinessBuyerInfoResponse -
  162. GetBusinessDocumentsInfoResponse -
  163. GetBusinessSettingsInfoDTO -
  164. GetBusinessSettingsResponse -
  165. GetCampaignLoginsResponse -
  166. GetCampaignOfferDTO -
  167. GetCampaignOffersRequest -
  168. GetCampaignOffersResponse -
  169. GetCampaignOffersResultDTO -
  170. GetCampaignRegionResponse -
  171. GetCampaignResponse -
  172. GetCampaignSettingsResponse -
  173. GetCampaignsResponse -
  174. GetCategoriesMaxSaleQuantumDTO -
  175. GetCategoriesMaxSaleQuantumRequest -
  176. GetCategoriesMaxSaleQuantumResponse -
  177. GetCategoriesRequest -
  178. GetCategoriesResponse -
  179. GetCategoryContentParametersResponse -
  180. GetChatHistoryRequest -
  181. GetChatHistoryResponse -
  182. GetChatInfoDTO -
  183. GetChatsInfoDTO -
  184. GetChatsRequest -
  185. GetChatsResponse -
  186. GetDeliveryServicesResponse -
  187. GetFeedIndexLogsResponse -
  188. GetFeedResponse -
  189. GetFeedbackListResponse -
  190. GetFeedsResponse -
  191. GetFulfillmentWarehousesResponse -
  192. GetGoodsFeedbackCommentsRequest -
  193. GetGoodsFeedbackCommentsResponse -
  194. GetGoodsFeedbackRequest -
  195. GetGoodsFeedbackResponse -
  196. GetGoodsStatsRequest -
  197. GetGoodsStatsResponse -
  198. GetHiddenOffersResponse -
  199. GetHiddenOffersResultDTO -
  200. GetMappingDTO -
  201. GetModelsOffersResponse -
  202. GetModelsRequest -
  203. GetModelsResponse -
  204. GetOfferCardsContentStatusRequest -
  205. GetOfferCardsContentStatusResponse -
  206. GetOfferDTO -
  207. GetOfferMappingDTO -
  208. GetOfferMappingEntriesResponse -
  209. GetOfferMappingsRequest -
  210. GetOfferMappingsResponse -
  211. GetOfferMappingsResultDTO -
  212. GetOfferRecommendationsRequest -
  213. GetOfferRecommendationsResponse -
  214. GetOffersResponse -
  215. GetOrderBuyerInfoResponse -
  216. GetOrderLabelsDataResponse -
  217. GetOrderResponse -
  218. GetOrdersResponse -
  219. GetOrdersStatsRequest -
  220. GetOrdersStatsResponse -
  221. GetOutletLicensesResponse -
  222. GetOutletResponse -
  223. GetOutletsResponse -
  224. GetPriceDTO -
  225. GetPriceWithDiscountDTO -
  226. GetPriceWithVatDTO -
  227. GetPricesByOfferIdsRequest -
  228. GetPricesByOfferIdsResponse -
  229. GetPricesResponse -
  230. GetPromoAssortmentInfoDTO -
  231. GetPromoBestsellerInfoDTO -
  232. GetPromoConstraintsDTO -
  233. GetPromoDTO -
  234. GetPromoMechanicsInfoDTO -
  235. GetPromoOfferDTO -
  236. GetPromoOffersRequest -
  237. GetPromoOffersResponse -
  238. GetPromoOffersResultDTO -
  239. GetPromoPromocodeInfoDTO -
  240. GetPromosRequest -
  241. GetPromosResponse -
  242. GetPromosResultDTO -
  243. GetQualityRatingDetailsResponse -
  244. GetQualityRatingRequest -
  245. GetQualityRatingResponse -
  246. GetQuarantineOffersRequest -
  247. GetQuarantineOffersResponse -
  248. GetQuarantineOffersResultDTO -
  249. GetRegionWithChildrenResponse -
  250. GetRegionsResponse -
  251. GetReportInfoResponse -
  252. GetReturnResponse -
  253. GetReturnsResponse -
  254. GetShipmentOrdersInfoResponse -
  255. GetShipmentResponse -
  256. GetSuggestedOfferMappingEntriesRequest -
  257. GetSuggestedOfferMappingEntriesResponse -
  258. GetSuggestedOfferMappingsRequest -
  259. GetSuggestedOfferMappingsResponse -
  260. GetSuggestedOfferMappingsResultDTO -
  261. GetWarehouseStocksDTO -
  262. GetWarehouseStocksRequest -
  263. GetWarehouseStocksResponse -
  264. GetWarehousesResponse -
  265. GoodsFeedbackCommentAuthorDTO -
  266. GoodsFeedbackCommentAuthorType -
  267. GoodsFeedbackCommentDTO -
  268. GoodsFeedbackCommentListDTO -
  269. GoodsFeedbackCommentStatusType -
  270. GoodsFeedbackDTO -
  271. GoodsFeedbackDescriptionDTO -
  272. GoodsFeedbackIdentifiersDTO -
  273. GoodsFeedbackListDTO -
  274. GoodsFeedbackMediaDTO -
  275. GoodsFeedbackStatisticsDTO -
  276. GoodsStatsDTO -
  277. GoodsStatsGoodsDTO -
  278. GoodsStatsWarehouseDTO -
  279. GoodsStatsWeightDimensionsDTO -
  280. GpsDTO -
  281. HiddenOfferDTO -
  282. LanguageType -
  283. LicenseCheckStatusType -
  284. LicenseType -
  285. LogisticPickupPointDTO -
  286. LogisticPointType -
  287. MappingsOfferDTO -
  288. MappingsOfferInfoDTO -
  289. MaxSaleQuantumDTO -
  290. MechanicsType -
  291. ModelDTO -
  292. ModelOfferDTO -
  293. ModelPriceDTO -
  294. ModelsDTO -
  295. OfferAvailabilityStatusType -
  296. OfferCampaignStatusDTO -
  297. OfferCampaignStatusType -
  298. OfferCardDTO -
  299. OfferCardRecommendationDTO -
  300. OfferCardRecommendationType -
  301. OfferCardStatusType -
  302. OfferCardsContentStatusDTO -
  303. OfferConditionDTO -
  304. OfferConditionQualityType -
  305. OfferConditionType -
  306. OfferContentDTO -
  307. OfferContentErrorDTO -
  308. OfferContentErrorType -
  309. OfferDTO -
  310. OfferErrorDTO -
  311. OfferForRecommendationDTO -
  312. OfferManualDTO -
  313. OfferMappingDTO -
  314. OfferMappingEntriesDTO -
  315. OfferMappingEntryDTO -
  316. OfferMappingErrorDTO -
  317. OfferMappingErrorType -
  318. OfferMappingInfoDTO -
  319. OfferMappingKindType -
  320. OfferMappingSuggestionsListDTO -
  321. OfferParamDTO -
  322. OfferPriceByOfferIdsListResponseDTO -
  323. OfferPriceByOfferIdsResponseDTO -
  324. OfferPriceDTO -
  325. OfferPriceListResponseDTO -
  326. OfferPriceResponseDTO -
  327. OfferProcessingNoteDTO -
  328. OfferProcessingNoteType -
  329. OfferProcessingStateDTO -
  330. OfferProcessingStatusType -
  331. OfferRecommendationDTO -
  332. OfferRecommendationInfoDTO -
  333. OfferRecommendationsResultDTO -
  334. OfferSellingProgramDTO -
  335. OfferSellingProgramStatusType -
  336. OfferType -
  337. OfferWeightDimensionsDTO -
  338. OffersDTO -
  339. OptionValuesLimitedDTO -
  340. OrderBoxLayoutDTO -
  341. OrderBoxLayoutItemDTO -
  342. OrderBoxLayoutPartialCountDTO -
  343. OrderBoxesLayoutDTO -
  344. OrderBusinessBuyerDTO -
  345. OrderBusinessDocumentsDTO -
  346. OrderBuyerBasicInfoDTO -
  347. OrderBuyerDTO -
  348. OrderBuyerInfoDTO -
  349. OrderBuyerType -
  350. OrderCancellationReasonType -
  351. OrderCourierDTO -
  352. OrderDTO -
  353. OrderDeliveryAddressDTO -
  354. OrderDeliveryDTO -
  355. OrderDeliveryDateDTO -
  356. OrderDeliveryDateReasonType -
  357. OrderDeliveryDatesDTO -
  358. OrderDeliveryDispatchType -
  359. OrderDeliveryEacType -
  360. OrderDeliveryPartnerType -
  361. OrderDeliveryType -
  362. OrderDigitalItemDTO -
  363. OrderDocumentStatusType -
  364. OrderItemDTO -
  365. OrderItemDetailDTO -
  366. OrderItemInstanceDTO -
  367. OrderItemInstanceModificationDTO -
  368. OrderItemInstanceType -
  369. OrderItemModificationDTO -
  370. OrderItemPromoDTO -
  371. OrderItemStatusType -
  372. OrderItemSubsidyDTO -
  373. OrderItemSubsidyType -
  374. OrderItemsModificationRequestReasonType -
  375. OrderItemsModificationResultDTO -
  376. OrderLabelDTO -
  377. OrderLiftType -
  378. OrderParcelBoxDTO -
  379. OrderPaymentMethodType -
  380. OrderPaymentType -
  381. OrderPromoType -
  382. OrderShipmentDTO -
  383. OrderStateDTO -
  384. OrderStatsStatusType -
  385. OrderStatusChangeDTO -
  386. OrderStatusChangeDeliveryDTO -
  387. OrderStatusChangeDeliveryDatesDTO -
  388. OrderStatusType -
  389. OrderSubsidyDTO -
  390. OrderSubsidyType -
  391. OrderSubstatusType -
  392. OrderTaxSystemType -
  393. OrderTrackDTO -
  394. OrderUpdateStatusType -
  395. OrderVatType -
  396. OrdersShipmentInfoDTO -
  397. OrdersStatsCommissionDTO -
  398. OrdersStatsCommissionType -
  399. OrdersStatsDTO -
  400. OrdersStatsDeliveryRegionDTO -
  401. OrdersStatsDetailsDTO -
  402. OrdersStatsItemDTO -
  403. OrdersStatsItemStatusType -
  404. OrdersStatsOrderDTO -
  405. OrdersStatsOrderPaymentType -
  406. OrdersStatsPaymentDTO -
  407. OrdersStatsPaymentOrderDTO -
  408. OrdersStatsPaymentSourceType -
  409. OrdersStatsPaymentType -
  410. OrdersStatsPriceDTO -
  411. OrdersStatsPriceType -
  412. OrdersStatsStockType -
  413. OrdersStatsWarehouseDTO -
  414. OutletAddressDTO -
  415. OutletDTO -
  416. OutletDeliveryRuleDTO -
  417. OutletLicenseDTO -
  418. OutletLicensesResponseDTO -
  419. OutletResponseDTO -
  420. OutletStatusType -
  421. OutletType -
  422. OutletVisibilityType -
  423. OutletWorkingScheduleDTO -
  424. OutletWorkingScheduleItemDTO -
  425. PageFormatType -
  426. PagedReturnsDTO -
  427. PalletsCountDTO -
  428. ParameterType -
  429. ParameterValueConstraintsDTO -
  430. ParameterValueDTO -
  431. ParameterValueOptionDTO -
  432. ParcelBoxDTO -
  433. ParcelBoxLabelDTO -
  434. ParcelDTO -
  435. PartnerShipmentWarehouseDTO -
  436. PaymentFrequencyType -
  437. PickupAddressDTO -
  438. PlacementType -
  439. PriceCompetitivenessThresholdsDTO -
  440. PriceCompetitivenessType -
  441. PriceDTO -
  442. PriceQuarantineVerdictDTO -
  443. PriceQuarantineVerdictParamNameType -
  444. PriceQuarantineVerdictParameterDTO -
  445. PriceQuarantineVerdictType -
  446. PriceRecommendationItemDTO -
  447. PriceSuggestDTO -
  448. PriceSuggestOfferDTO -
  449. PriceSuggestType -
  450. PromoOfferAutoParticipatingDetailsDTO -
  451. PromoOfferDiscountParamsDTO -
  452. PromoOfferParamsDTO -
  453. PromoOfferParticipationStatusFilterType -
  454. PromoOfferParticipationStatusType -
  455. PromoOfferPromocodeParamsDTO -
  456. PromoOfferUpdateWarningCodeType -
  457. PromoOfferUpdateWarningDTO -
  458. PromoParticipationType -
  459. PromoPeriodDTO -
  460. ProvideOrderDigitalCodesRequest -
  461. ProvideOrderItemIdentifiersRequest -
  462. ProvideOrderItemIdentifiersResponse -
  463. PutSkuBidsRequest -
  464. QualityRatingAffectedOrderDTO -
  465. QualityRatingComponentDTO -
  466. QualityRatingComponentType -
  467. QualityRatingDTO -
  468. QualityRatingDetailsDTO -
  469. QuantumDTO -
  470. QuarantineOfferDTO -
  471. RecipientType -
  472. RefundStatusType -
  473. RegionDTO -
  474. RegionType -
  475. RegionalModelInfoDTO -
  476. RejectedPromoOfferDeleteDTO -
  477. RejectedPromoOfferDeleteReasonType -
  478. RejectedPromoOfferUpdateDTO -
  479. RejectedPromoOfferUpdateReasonType -
  480. ReportFormatType -
  481. ReportInfoDTO -
  482. ReportStatusType -
  483. ReportSubStatusType -
  484. ReturnDTO -
  485. ReturnDecisionDTO -
  486. ReturnDecisionReasonType -
  487. ReturnDecisionSubreasonType -
  488. ReturnDecisionType -
  489. ReturnInstanceDTO -
  490. ReturnInstanceStatusType -
  491. ReturnInstanceStockType -
  492. ReturnItemDTO -
  493. ReturnRequestDecisionType -
  494. ReturnShipmentStatusType -
  495. ReturnType -
  496. ScrollingPagerDTO -
  497. SearchModelsResponse -
  498. SearchShipmentsRequest -
  499. SearchShipmentsResponse -
  500. SearchShipmentsResponseDTO -
  501. SellingProgramType -
  502. SendMessageToChatRequest -
  503. SetFeedParamsRequest -
  504. SetOrderBoxLayoutRequest -
  505. SetOrderBoxLayoutResponse -
  506. SetOrderDeliveryDateRequest -
  507. SetOrderDeliveryTrackCodeRequest -
  508. SetOrderShipmentBoxesRequest -
  509. SetOrderShipmentBoxesResponse -
  510. SetReturnDecisionRequest -
  511. SetShipmentPalletsCountRequest -
  512. ShelfsStatisticsAttributionType -
  513. ShipmentActionType -
  514. ShipmentBoxesDTO -
  515. ShipmentDTO -
  516. ShipmentInfoDTO -
  517. ShipmentPalletLabelPageFormatType -
  518. ShipmentStatusChangeDTO -
  519. ShipmentStatusType -
  520. ShipmentType -
  521. ShowsSalesGroupingType -
  522. SkipGoodsFeedbackReactionRequest -
  523. SkuBidItemDTO -
  524. SkuBidRecommendationItemDTO -
  525. SortOrderType -
  526. SuggestOfferPriceDTO -
  527. SuggestPricesRequest -
  528. SuggestPricesResponse -
  529. SuggestPricesResultDTO -
  530. SuggestedOfferDTO -
  531. SuggestedOfferMappingDTO -
  532. TariffDTO -
  533. TariffParameterDTO -
  534. TariffType -
  535. TimePeriodDTO -
  536. TimeUnitType -
  537. TrackDTO -
  538. TransferOrdersFromShipmentRequest -
  539. TurnoverDTO -
  540. TurnoverType -
  541. UnitDTO -
  542. UpdateBusinessOfferPriceDTO -
  543. UpdateBusinessPricesRequest -
  544. UpdateCampaignOfferDTO -
  545. UpdateCampaignOffersRequest -
  546. UpdateGoodsFeedbackCommentDTO -
  547. UpdateGoodsFeedbackCommentRequest -
  548. UpdateGoodsFeedbackCommentResponse -
  549. UpdateMappingDTO -
  550. UpdateMappingsOfferDTO -
  551. UpdateOfferContentRequest -
  552. UpdateOfferContentResponse -
  553. UpdateOfferContentResultDTO -
  554. UpdateOfferDTO -
  555. UpdateOfferMappingDTO -
  556. UpdateOfferMappingEntryDTO -
  557. UpdateOfferMappingEntryRequest -
  558. UpdateOfferMappingResultDTO -
  559. UpdateOfferMappingsRequest -
  560. UpdateOfferMappingsResponse -
  561. UpdateOrderItemRequest -
  562. UpdateOrderStatusDTO -
  563. UpdateOrderStatusRequest -
  564. UpdateOrderStatusResponse -
  565. UpdateOrderStatusesDTO -
  566. UpdateOrderStatusesRequest -
  567. UpdateOrderStatusesResponse -
  568. UpdateOrderStorageLimitRequest -
  569. UpdateOutletLicenseRequest -
  570. UpdatePriceWithDiscountDTO -
  571. UpdatePricesRequest -
  572. UpdatePromoOfferDTO -
  573. UpdatePromoOfferDiscountParamsDTO -
  574. UpdatePromoOfferParamsDTO -
  575. UpdatePromoOffersRequest -
  576. UpdatePromoOffersResponse -
  577. UpdatePromoOffersResultDTO -
  578. UpdateStockDTO -
  579. UpdateStockItemDTO -
  580. UpdateStocksRequest -
  581. UpdateTimeDTO -
  582. ValueRestrictionDTO -
  583. VerifyOrderEacRequest -
  584. VerifyOrderEacResponse -
  585. WarehouseAddressDTO -
  586. WarehouseDTO -
  587. WarehouseGroupDTO -
  588. WarehouseOfferDTO -
  589. WarehouseOffersDTO -
  590. WarehouseStockDTO -
  591. WarehouseStockType -
  592. WarehousesDTO -
  593. WarningPromoOfferUpdateDTO -

AcceptOrderCancellationRequest - Up

accepted
Boolean

Решение об отмене заказа:

  • true — заказ отменяется, служба доставки узнала об отмене до передачи заказа покупателю.
  • false — заказ не отменяется, так как он уже доставлен покупателю курьером или передан в пункт выдачи заказов.
reason (optional)

AddHiddenOffersRequest - Up

Запрос на скрытие оферов.
hiddenOffers
array[HiddenOfferDTO] Список скрытых товаров.

AddOffersToArchiveDTO - Up

Товары, которые не удалось поместить в архив.
notArchivedOffers (optional)
array[AddOffersToArchiveErrorDTO] Список товаров, которые не удалось поместить в архив.

AddOffersToArchiveErrorDTO - Up

Товар, который не удалось поместить в архив.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

error

AddOffersToArchiveErrorType - Up

Причина, по которой товар не удалось поместить в архив:

AddOffersToArchiveRequest - Up

Товары, которые нужно поместить в архив.
offerIds
array[String] Список товаров, которые нужно поместить в архив.

AddOffersToArchiveResponse - Up

Результат архивации товаров.
status (optional)
result (optional)

AffectedOrderQualityRatingComponentType - Up

Составляющие индекса качества.

Для модели DBS:

Для моделей FBS и Экспресс:

AgeDTO - Up

Возраст в заданных единицах измерения.
value
BigDecimal Значение.
ageUnit

AgeUnitType - Up

Единицы измерения возраста:

ApiClientDataErrorResponse - Up

Ошибка в данных переданных от клиента.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiErrorDTO - Up

Общий формат ошибки.
code
String Код ошибки.
message (optional)
String Описание ошибки.

ApiErrorResponse - Up

Стандартная обертка для ошибок сервера.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiForbiddenErrorResponse - Up

Неверны авторизационные данные, указанные в запросе, или запрещен доступ к запрашиваемому ресурсу.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiLimitErrorResponse - Up

Превышено ограничение на доступ к ресурсу.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiLockedErrorResponse - Up

Ресурс из запроса заблокирован от применения к нему указанного метода.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiNotFoundErrorResponse - Up

Запрашиваемый ресурс не найден.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiResponse - Up

Стандартная обертка для ответов сервера.
status (optional)

ApiResponseStatusType - Up

Тип ответа.

ApiServerErrorResponse - Up

Внутренняя ошибка сервера.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

ApiUnauthorizedErrorResponse - Up

В запросе не указаны авторизационные данные.
status (optional)
errors (optional)
array[ApiErrorDTO] Список ошибок.

BaseCampaignOfferDTO - Up

Информация о новой цене на товар.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

quantum (optional)
available (optional)
Boolean Есть ли товар в продаже.

BaseOfferDTO - Up

Основные параметры товара.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

marketCategoryId (optional)
Long

Идентификатор категории на Маркете, к которой вы относите свой товар.

Если не указать marketCategoryId, то маркетная категория будет определена автоматически.

При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.

Список категорий Маркета можно получить с помощью запроса POST categories/tree.

format: int64
category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

pictures (optional)
array[String]

Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.

Требования к ссылкам

  • Ссылок может быть до 30.
  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/images/sku12345.jpg

https://yadi.sk/i/NaBoRsimVOLov

/images/sku12345.jpg

https://www.dropbox.com/s/818f/tovar.jpg

Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.

Требования к изображениям

videos (optional)
array[String]

Ссылка (URL) на видео товара.

Максимальное количество ссылок — 6.

Требования к ссылке

  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/video/sku12345.avi

https://yadi.sk/i/NaBoRsimVOLov

/video/sku12345.avi

https://www.dropbox.com/s/818f/super-tovar.avi

Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.

Требования к видео

manuals (optional)
array[OfferManualDTO]

Список инструкций по использованию товара.

Максимальное количество инструкций — 6.

Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

manufacturerCountries (optional)
array[String]

Страна, где был произведен товар.

Записывайте названия стран так, как они записаны в списке.

weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String]

Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.

Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.

shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String

Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.

Обязательно укажите, если он есть.

certificates (optional)
array[String]

Номера документов на товар: сертификата, декларации соответствия и т. п.

Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.

boxCount (optional)
Integer

Количество грузовых мест.

Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.

Для товаров, занимающих одно место, не передавайте этот параметр.

format: int32
condition (optional)
type (optional)
downloadable (optional)
Boolean

Признак цифрового товара. Укажите true, если товар доставляется по электронной почте.

Как работать с цифровыми товарами

adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO]

{% note warning "" %}

Этот параметр устарел. При передаче характеристик используйте parameterValues.

{% endnote %}

Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.

BasePriceDTO - Up

Цена на товар.
value
BigDecimal Значение.
currencyId

BaseShipmentDTO - Up

Информация об отгрузке.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32

BidRecommendationItemDTO - Up

Рекомендованная ставка и возможная доля показов.
bid
Integer Значение ставки. format: int32
showPercent
Long Доля показов. format: int64

BriefOrderItemDTO - Up

Информация о маркированном товаре.
id (optional)
Long

Идентификатор товара в заказе.

Позволяет идентифицировать товар в рамках данного заказа.

format: int64
vat (optional)
count (optional)
Integer Количество единиц товара. format: int32
price (optional)
BigDecimal Цена на товар. Указана в той валюте, которая была задана в каталоге. Разделитель целой и дробной части — точка.
offerName (optional)
String Название товара.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

instances (optional)
array[OrderItemInstanceDTO] Переданные вами коды маркировки.

BriefOrderItemInstanceDTO - Up

Идентификатор единицы товара.

Заполните только одно поле в зависимости от того, в какой системе маркирован товар.

Подробно о работе с маркируемыми товарами рассказано в Справке Маркета для продавцов.

cis (optional)
String

Код идентификации единицы товара в системе «Честный ЗНАК».

{% note warning %}

Не экранируйте косую черту в коде символа-разделителя \u001d!

01030410947874432155Qbag!\u001d93Zjqw

01030410947874432155Qbag!\\u001d93Zjqw

Косые черты и кавычки в других местах экранируйте по правилам JSON: \\ и \"

{% endnote %}

uin (optional)
String

Уникальный идентификационный номер ювелирного изделия.

Представляет собой число из 16 цифр.

rnpt (optional)
String

Регистрационный номер партии товара.

Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.

gtd (optional)
String

Грузовая таможенная декларация.

Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.

BusinessDTO - Up

Информация о кабинете.
id (optional)
Long Идентификатор кабинета. format: int64
name (optional)
String Название бизнеса.

BusinessSettingsDTO - Up

Настройки кабинета.
onlyDefaultPrice (optional)
Boolean

Можно ли установить только базовую цену:

  • false — можно задать и базовую цену, и цены в конкретных магазинах.
  • true — можно задать только базовую цену.
currency (optional)

CalculateTariffsOfferDTO - Up

Параметры товара, для которого нужно рассчитать стоимость услуг.
categoryId
Long

Идентификатор категории товара на Маркете.

Для расчета стоимости услуг необходимо указать идентификатор листовой категории товара — той, которая не имеет дочерних категорий.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.

format: int64
price
BigDecimal Цена на товар в рублях.
length
BigDecimal Длина товара в сантиметрах.
width
BigDecimal Ширина товара в сантиметрах.
height
BigDecimal Высота товара в сантиметрах.
weight
BigDecimal Вес товара в килограммах.
quantity (optional)
Integer Квант продажи — количество единиц товара в одном товарном предложении. format: int32

CalculateTariffsOfferInfoDTO - Up

Стоимость услуг.
offer
tariffs
array[CalculatedTariffDTO]

Список услуг и их стоимость.

По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.

CalculateTariffsParametersDTO - Up

Параметры для расчета стоимости услуг.
campaignId (optional)
Long

Идентификатор кампании. У пользователя, который выполняет запрос, должен быть доступ к этой кампании.

Используйте параметр campaignId, если уже завершили подключение магазина на Маркете. Иначе вернется пустой список.

Обязательный параметр, если не указан параметр sellingProgram. Совместное использование параметров приведет к ошибке.

format: int64
sellingProgram (optional)
frequency (optional)

CalculateTariffsRequest - Up

parameters
offers
array[CalculateTariffsOfferDTO] Товары, для которых нужно рассчитать стоимость услуг.

CalculateTariffsResponse - Up

status (optional)
result (optional)

CalculateTariffsResponseDTO - Up

Расчет стоимости услуг.
offers
array[CalculateTariffsOfferInfoDTO] Стоимость услуг.

CalculatedTariffDTO - Up

Информация об услугах Маркета.
type
amount (optional)
BigDecimal Стоимость услуги в рублях.
parameters
array[TariffParameterDTO] Параметры расчета тарифа.

CalculatedTariffType - Up

Услуга Маркета:

Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.

CampaignDTO - Up

Информация о магазине.
domain (optional)
String URL магазина.
id (optional)
Long Идентификатор кампании. format: int64
clientId (optional)
Long Идентификатор плательщика в Яндекс Балансе. format: int64
business (optional)
placementType (optional)

CampaignQualityRatingDTO - Up

Информация об индексе качества магазина.
campaignId
Long Идентификатор магазина. format: int64
ratings
array[QualityRatingDTO] Список значений индекса качества.

CampaignSettingsDTO - Up

Настройки магазина.
countryRegion (optional)
Long Идентификатор региона, в котором находится магазин. format: int64
shopName (optional)
String Наименование магазина на Яндекс Маркете. Если наименование отсутствует, значение параметра выводится — null.
showInContext (optional)
Boolean

Признак размещения магазина на сайтах партнеров Яндекс Дистрибуции. Возможные значения:

  • false — магазин не размещен на сайтах партнеров Яндекс Дистрибуции.
  • true — магазин размещен на сайтах партнеров Яндекс Дистрибуции.
showInPremium (optional)
Boolean

Признак показа предложений магазина в рекламном блоке над результатами поиска (cпецразмещение). Возможные значения:

  • false — предложения не показываются в блоке cпецразмещения.
  • true — предложения показываются в блоке cпецразмещения.
useOpenStat (optional)
Boolean

Признак использования внешней интернет-статистики. Возможные значения:

  • false — внешняя интернет-статистика не используется.
  • true — внешняя интернет-статистика используется.
localRegion (optional)

CampaignSettingsDeliveryDTO - Up

Информация о доставке в своем регионе магазина.
schedule (optional)

CampaignSettingsLocalRegionDTO - Up

Информация о своем регионе магазина.
id (optional)
Long Идентификатор региона. format: int64
name (optional)
String Название региона.
type (optional)
deliveryOptionsSource (optional)
delivery (optional)

CampaignSettingsScheduleDTO - Up

Расписание работы службы доставки в своем регионе.
availableOnHolidays (optional)
Boolean

Признак работы службы доставки в государственные праздники. Возможные значения.

  • false — служба доставки не работает в праздничные дни.
  • true — служба доставки работает в праздничные дни.
customHolidays
array[String] Список дней, в которые служба доставки не работает. Дни магазин указал в кабинете продавца на Маркете. format: date-dd-MM-yyyy
customWorkingDays
array[String] Список выходных и праздничных дней, в которые служба доставки работает. Дни магазин указал в кабинете продавца на Маркете. format: date-dd-MM-yyyy
period (optional)
totalHolidays
array[String] Итоговый список нерабочих дней службы доставки. Список рассчитывается с учетом выходных, нерабочих дней и государственных праздников. Информацию по ним магазин указывает в кабинете продавца на Маркете. format: date-dd-MM-yyyy
weeklyHolidays
array[Integer] Список выходных дней недели и государственных праздников. format: int32

CampaignSettingsScheduleSourceType - Up

Источник информации о расписании работы службы доставки. Возможные значения:

CampaignSettingsTimePeriodDTO - Up

Период, за который рассчитывается итоговый список нерабочих дней службы доставки.
fromDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
toDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy

CampaignsQualityRatingDTO - Up

Информация об индексе качества магазинов.
campaignRatings
array[CampaignQualityRatingDTO] Список магазинов c информацией об их индексе качества.

CategoryContentParametersDTO - Up

Информация о параметрах категории.
categoryId
Integer Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree. format: int32
parameters (optional)
array[CategoryParameterDTO] Список характеристик.

CategoryDTO - Up

Информация о категории.

Категория считается листовой, если у нее нет дочерних категорий.

id
Long Идентификатор категории. format: int64
name
String Название категории.
children (optional)
array[CategoryDTO] Дочерние категории.

CategoryErrorDTO - Up

Текст ошибки.
categoryId (optional)
Long Идентификатор категории. format: int64
type (optional)

CategoryErrorType - Up

Типы ошибок:

CategoryParameterDTO - Up

Характеристика товара.
id
Long Идентификатор характеристики. format: int64
name (optional)
String Название характеристики.
type
unit (optional)
description (optional)
String Описание характеристики.
recommendationTypes (optional)
array[OfferCardRecommendationType] Перечень возможных рекомендаций по заполнению карточки, к которым относится данная характеристика.
required
Boolean Обязательность характеристики.
filtering
Boolean Используется ли характеристика в фильтре.
distinctive
Boolean Является ли характеристика особенностью варианта.
multivalue
Boolean Можно ли передать сразу несколько значений.
allowCustomValues
Boolean Можно ли передавать собственное значение, которого нет в списке вариантов Маркета. Только для характеристик типа ENUM.
values (optional)
array[ParameterValueOptionDTO] Список допустимых значений параметра. Только для характеристик типа ENUM.
constraints (optional)
valueRestrictions (optional)
array[ValueRestrictionDTO] Ограничения на значения, накладываемые другими характеристиками. Только для характеристик типа ENUM.

CategoryParameterUnitDTO - Up

Единицы измерения характеристики товара.
defaultUnitId
Long Единица измерения по умолчанию. format: int64
units
array[UnitDTO] Допустимые единицы измерения.

ChangeOutletRequest - Up

name
String Название точки продаж.
type
coords (optional)
String

Координаты точки продаж.

Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.

Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.

isMain (optional)
Boolean

Признак основной точки продаж.

Возможные значения:

  • false — неосновная точка продаж.
  • true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате: +7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO]

Информация об условиях доставки для данной точки продаж.

Обязательный параметр, если параметр type=DEPOT или type=MIXED.

storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64

ChannelType - Up

Каналы продвижения товаров:

ChatMessageDTO - Up

Информация о сообщениях.
messageId
Long Идентификатор сообщения. format: int64
createdAt
Date

Дата и время создания сообщения.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.

format: date-time
sender
message (optional)
String

Текст сообщения.

Необязательный параметр, если возвращается параметр payload.

payload (optional)
array[ChatMessagePayloadDTO]

Информация о приложенных к сообщению файлах.

Необязательный параметр, если возвращается параметр message.

ChatMessagePayloadDTO - Up

Информация о приложенных к сообщению файлах.
name
String Имя файла.
url
String Ссылка для скачивания файла.
size
Integer Размер файла в байтах. format: int32

ChatMessageSenderType - Up

Кто отправил сообщение:

ChatMessagesResultDTO - Up

Информация о сообщениях.
orderId
Long Идентификатор заказа. format: int64
messages
array[ChatMessageDTO] Информация о сообщениях.
paging (optional)

ChatStatusType - Up

Статус чата:

ChatType - Up

Тип чата:

ConfirmPricesRequest - Up

Запрос на подтверждение цены.
offerIds
array[String] Идентификаторы товаров, у которых подтверждается цена.

ConfirmShipmentRequest - Up

Запрос для подтверждения отгрузки.
externalShipmentId (optional)
String Идентификатор отгрузки в системе поставщика.

CreateChatRequest - Up

Заказ, для которого нужно создать чат.
orderId
Long Идентификатор заказа на Маркете. format: int64

CreateChatResponse - Up

Результат создания чата.
status (optional)
result (optional)

CreateChatResultDTO - Up

Информация о созданном чате.
chatId
Long Идентификатор чата. format: int64

CreateOutletResponse - Up

Ответ на запрос о создании точки продаж.
status (optional)
result (optional)

CurrencyType - Up

Коды валют. Возможные значения:

DayOfWeekType - Up

День недели:

DeleteCampaignOffersDTO - Up

Список товаров, которые не удалось удалить, потому что они не найдены или хранятся на складе Маркета.
notDeletedOfferIds (optional)
array[String] Список SKU.

DeleteCampaignOffersRequest - Up

Фильтрации удаляемых товаров по offerIds.
offerIds
array[String] Идентификаторы товаров в каталоге.

DeleteCampaignOffersResponse - Up

Результат удаления товаров.
status (optional)
result (optional)

DeleteGoodsFeedbackCommentRequest - Up

Фильтр запроса отзывов по бизнесу.
id
Long Идентификатор комментария к отзыву. format: int64

DeleteHiddenOffersRequest - Up

Запрос на возобновление показа оферов.
hiddenOffers
array[HiddenOfferDTO] Список скрытых товаров.

DeleteOffersDTO - Up

Список товаров, которые не удалось удалить, потому что они хранятся на складе Маркета.
notDeletedOfferIds (optional)
array[String] Список SKU товаров, которые не удалось удалить.

DeleteOffersFromArchiveDTO - Up

Товары, которые не удалось восстановить из архива.
notUnarchivedOfferIds (optional)
array[String] Список товаров, которые не удалось восстановить из архива.

DeleteOffersFromArchiveRequest - Up

Товары, которые нужно восстановить из архива.
offerIds
array[String] Список товаров, которые нужно восстановить из архива.

DeleteOffersFromArchiveResponse - Up

Результат разархивации товаров.
status (optional)
result (optional)

DeleteOffersRequest - Up

Фильтрации удаляемых товаров по offerIds.
offerIds
array[String] Список SKU товаров, которые нужно удалить.

DeleteOffersResponse - Up

Результат удаления товаров.
status (optional)
result (optional)

DeletePromoOffersRequest - Up

Удаление товаров из акции.

Чтобы убрать:

promoId
String Идентификатор акции.
deleteAllOffers (optional)
Boolean Чтобы убрать все товары из акции и больше не участвовать в ней, передайте значение true и не передавайте параметр offerIds.
offerIds (optional)
array[String] Товары, которые нужно убрать из акции.

DeletePromoOffersResponse - Up

Результат удаления товаров из акции.
status (optional)
result (optional)

DeletePromoOffersResultDTO - Up

Результат удаления товаров из акции.

Возвращается, только если в запросе был передан параметр offerIds.

rejectedOffers (optional)
array[RejectedPromoOfferDeleteDTO]

Товары, при удалении которых появились ошибки.

Возвращается, только если есть такие товары.

DeliveryServiceDTO - Up

Служба доставки.
id (optional)
Long Идентификатор службы доставки. format: int64
name (optional)
String Наименование службы доставки.

DeliveryServiceInfoDTO - Up

Информация о службе доставки.
id
Long Идентификатор службы доставки. format: int64
name
String Наименование службы доставки.

DeliveryServicesDTO - Up

Информация о службах доставки.
deliveryService
array[DeliveryServiceInfoDTO] Информация о службе доставки.

DocumentDTO - Up

Информация о документе.
status (optional)
number (optional)
String Номер документа.
date (optional)
date Дата создания документа. format: date

EacVerificationResultDTO - Up

Результат выполнения запроса.
verificationResult (optional)
attemptsLeft (optional)
Integer

Количество оставшихся попыток проверки кода.

Возвращается, если магазин отправил некорректный код.

Когда все попытки будут исчерпаны, код обновится.

format: int32

EacVerificationStatusType - Up

Статус проверки кода подтверждения:

EmptyApiResponse - Up

Пустой ответ сервера.
status (optional)

EnrichedMappingsOfferDTO - Up

Информация о рекомендованных карточках товаров.
name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

id (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

urls (optional)
array[String]

URL фотографии товара или страницы с описанием на вашем сайте.

Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.

Должен содержать один вложенный параметр url.

pictures (optional)
array[String]

Ссылки (URL) изображений товара в хорошем качестве.

Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.

Обязательный параметр.

Должен содержать хотя бы один вложенный параметр picture.

manufacturer (optional)
String

Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).

Необязательный параметр.

manufacturerCountries (optional)
array[String]

Список стран, в которых произведен товар.

Обязательный параметр.

Должен содержать хотя бы одну, но не больше 5 стран.

minShipment (optional)
Integer

Минимальное количество единиц товара, которое вы поставляете на склад.

Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.

format: int32
transportUnitSize (optional)
Integer

Количество единиц товара в одной упаковке, которую вы поставляете на склад.

Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.

format: int32
quantumOfSupply (optional)
Integer

Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.

Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.

format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer

Сколько мест (если больше одного) занимает товар.

Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.

format: int32
customsCommodityCodes (optional)
array[String]

Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).

Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).

Может содержать только один вложенный код ТН ВЭД.

weightDimensions (optional)
supplyScheduleDays (optional)
array[DayOfWeekType] Дни недели, в которые продавец поставляет товары на склад.
shelfLifeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок годности: через сколько дней товар станет непригоден для использования.

format: int32
lifeTimeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.

format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String

Номер документа на товар.

Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция

price (optional)
BigDecimal Цена на товар в рублях.
marketCategoryId (optional)
Long

Идентификатор категории для рекомендованной карточки товара на Маркете.

Возвращается только вместе с параметром ##marketSku##.

format: int64
marketCategoryName (optional)
String

Название категории для рекомендованной карточки товара на Маркете.

Может отсутствовать в ответе.

marketModelId (optional)
Long

Идентификатор модели для рекомендованной карточки товара на Маркете.

Может отсутствовать в ответе.

format: int64
marketModelName (optional)
String

Название модели для рекомендованной карточки товара на Маркете.

Возвращается только вместе с параметром ##marketSku##.

marketSku (optional)
Long SKU на Маркете. format: int64
marketSkuName (optional)
String

Название товара с рекомендованной карточки на Маркете.

Может отсутствовать в ответе.

EnrichedModelDTO - Up

Модель товара.
id (optional)
Long Идентификатор модели товара. format: int64
name (optional)
String Название модели товара.
prices (optional)
offers (optional)
array[ModelOfferDTO]

Список первых десяти предложений, расположенных на карточке модели.

В ответе на запрос возвращаются предложения различных магазинов. Если есть несколько предложений от одного магазина, в ответе отображается только одно, наиболее релевантное из них.

offlineOffers (optional)
Integer Суммарное количество предложений в розничных магазинах в регионе. Учитываются все предложения от каждого магазина. format: int32
onlineOffers (optional)
Integer Суммарное количество предложений в интернет-магазинах в регионе. Учитываются все предложения от каждого магазина. format: int32

EnrichedModelsDTO - Up

Список моделей товаров.
models
array[EnrichedModelDTO] Список моделей товаров.

EnrichedOrderBoxLayoutDTO - Up

Информация о коробке.
items
array[OrderBoxLayoutItemDTO]

Список товаров в коробке.

Если в коробке едет часть большого товара, в списке может быть только один пункт.

boxId (optional)
Long Идентификатор коробки. format: int64

ExtensionShipmentDTO - Up

Информация об отгрузке.
currentStatus (optional)
availableActions
set[ShipmentActionType] Доступные действия над отгрузкой.

FeedContentDTO - Up

Информация о проверке содержимого прайс-листа, загруженного на Маркет.
rejectedOffersCount (optional)
Long Количество предложений, в которых найдены ошибки на этапе загрузки прайс-листа. Выводится, если параметр content status=OK. format: int64
status (optional)
totalOffersCount (optional)
Long Количество предложений в прайс-листе. Выводится, если параметр content status=OK. format: int64
error (optional)

FeedContentErrorDTO - Up

Информация об ошибке в содержимом прайс-листа. Выводится, если параметр content status=ERROR.
type (optional)

FeedContentErrorType - Up

Тип ошибки в содержимом прайс-листа.

Возможные значения:

FeedDTO - Up

Информация о прайс-листе.
id (optional)
Long Идентификатор прайс-листа. format: int64
login (optional)
String Логин для авторизации при скачивании прайс-листа. Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.
name (optional)
String Имя файла, содержащего прайс-лист. Параметр выводится при размещении прайс-листа на сервере Маркета.
password (optional)
String Пароль для авторизации при скачивании прайс-листа. Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.
uploadDate (optional)
Date

Дата загрузки прайс-листа на Маркет.

Формат даты: ДД-ММ-ГГГГ.

Параметр выводится при размещении прайс-листа на сервере Маркета.

format: date-time
url (optional)
String URL прайс-листа. Параметр выводится при размещении прайс-листа на сайте магазина.
content (optional)
download (optional)
placement (optional)
publication (optional)

FeedDownloadDTO - Up

Информация о последней загрузке прайс-листа.
status (optional)
error (optional)

FeedDownloadErrorDTO - Up

Информация об ошибке при загрузке прайс-листа. Выводится, если параметр download status=ERROR.
httpStatusCode (optional)
Integer HTTP-код ошибки индексации прайс-листа. Выводится, если type=DOWNLOAD_HTTP_ERROR. format: int32
type (optional)
description (optional)
String Описание ошибки. Выводится, если type=DOWNLOAD_ERROR.

FeedDownloadErrorType - Up

Тип ошибки загрузки прайс-листа.

Возможные значения:

HTTP-код выведен в параметре httpStatusCode.

FeedIndexLogsErrorDTO - Up

Информация об ошибке, произошедшей во время индексации прайс-листа.

Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR).

httpStatusCode (optional)
Integer

HTTP-код ошибки индексации прайс-листа.

Выводится, если type=DOWNLOAD_HTTP_ERROR.

format: int32
type (optional)
description (optional)
String

Описание ошибки.

Выводится, если type=DOWNLOAD_ERROR.

FeedIndexLogsErrorType - Up

Тип ошибки индексации прайс-листа.

Возможные значения:

FeedIndexLogsFeedDTO - Up

Информация о прайс-листе.
id (optional)
Long Идентификатор прайс-листа. format: int64

FeedIndexLogsIndexType - Up

Тип обновления.

Возможные значения:

FeedIndexLogsOffersDTO - Up

Информация о предложениях прайс-листа.
rejectedCount (optional)
Long Количество предложений, который не опубликованы на Маркете из-за найденных ошибок. format: int64
totalCount (optional)
Long Количество предложений в прайс-листе. format: int64

FeedIndexLogsRecordDTO - Up

Список отчетов по индексации прайс-листа.
downloadTime (optional)
Date

Дата и время загрузки прайс-листа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time
fileTime (optional)
Date

Дата и время, которые магазин указал в прайс-листе.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time
generationId (optional)
Long Идентификатор индексации. format: int64
indexType (optional)
publishedTime (optional)
Date

Дата и время публикации предложений из прайс-листа на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time
status (optional)
error (optional)
offers (optional)

FeedIndexLogsResultDTO - Up

Результат выполнения запроса отчета по индексации прайс-листа.
feed (optional)
indexLogRecords
array[FeedIndexLogsRecordDTO] Список отчетов по индексации прайс-листа.
total (optional)
Long Количество отчетов на всех страницах выходных данных. format: int64

FeedIndexLogsStatusType - Up

Статус индексации прайс-листа и проверки на соответствие техническим требованиям.

Возможные значения:

FeedParameterDTO - Up

Параметр прайс-листа.
deleted (optional)
Boolean

Удалить ли значение параметра.

Возможное значение:

  • true — удалить значение параметра.

Используется вместе с параметром name.

name
String

Название параметра.

Возможное значение:

  • reparseIntervalMinutes — период скачивания прайс-листа. Маркет будет скачивать прайс-лист через количество минут, указанное в параметре value. Например, при value=1440, Маркет будет скачивать прайс-лист один раз в сутки.

{% note alert %}

Несмотря на установленное значение, Маркет скачает прайс-лист один раз в сутки.

{% endnote %}

Обязательный параметр.

values (optional)
array[Integer]

Значения параметра.

Используется вместе с параметром name.

format: int32

FeedPlacementDTO - Up

Информация о размещении предложений из прайс-листа на Маркете на момент выполнения запроса.
status (optional)
totalOffersCount (optional)
Integer Количество предложений из прайс-листа, которые размещаются на Яндекс Маркете в момент выполнения запроса. format: int32

FeedPublicationDTO - Up

Информация о последней публикации предложений из прайс-листа на Маркете.
status (optional)
full (optional)
priceAndStockUpdate (optional)

FeedPublicationFullDTO - Up

Информация о последней публикации предложений из прайс-листа на Маркете.
fileTime (optional)
Date

Дата и время, которые магазин указал в прайс-листе.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time
publishedTime (optional)
Date

Дата и время публикации предложений из прайс-листа на Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time

FeedPublicationPriceAndStockUpdateDTO - Up

Последнее обновление цен и наличия товаров на Маркете. Если последнее по времени обновление было полным, в параметре выводятся те же данные, что и в параметре full. Выводится, если параметр publication status=OK.
fileTime (optional)
Date

Дата и время, которые магазин указал в прайс-листе.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time
publishedTime (optional)
Date

Дата и время публикации предложений из прайс-листа на Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

format: date-time

FeedStatusType - Up

Статус прайс-листа.

Возможные значения:

FeedbackAuthorDTO - Up

Информация об авторе отзыва.

Если отзыв оставлен анонимно, параметр не возвращается.

name (optional)
String Имя автора отзыва.
region (optional)

FeedbackCommentAuthorDTO - Up

Информация об авторе комментария.
type (optional)
name (optional)
String Имя автора отзыва или название магазина.

FeedbackCommentAuthorType - Up

Тип автора:

FeedbackCommentDTO - Up

Комментарий к отзыву на магазин.
id (optional)
Long Идентификатор ответа. format: int64
parentId (optional)
Long Идентификатор родительского ответа. format: int64
body (optional)
String Текст ответа.
createdAt (optional)
Date

Дата и время создания ответа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.

format: date-time
updatedAt (optional)
Date

Дата и время изменения ответа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.

format: date-time
author (optional)
children (optional)
array[FeedbackCommentDTO] Дочерние ответы.

FeedbackDTO - Up

Отзыв пользователя Яндекс Маркета об указанном магазине.
id (optional)
Long Идентификатор отзыва. format: int64
createdAt (optional)
Date

Дата и время создания отзыва.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.

format: date-time
text (optional)
String Комментарий автора отзыва.
state (optional)
author (optional)
pro (optional)
String Достоинства магазина, описанные в отзыве.
contra (optional)
String Недостатки магазина, описанные в отзыве.
comments
array[FeedbackCommentDTO] Переписка автора отзыва с магазином.
shop (optional)
resolved (optional)
Boolean

Решена ли проблема автора отзыва:

  • true — да.
  • false — нет.

Если проблема решена, около отзыва на странице магазина появляется соответствующая надпись.

verified (optional)
Boolean

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Является ли отзыв рекомендованным:

  • true — да.
  • false — нет.
recommend (optional)
Boolean

Купил бы автор отзыва в магазине снова:

  • true — да.
  • false — нет.
grades (optional)
order (optional)

FeedbackDeliveryType - Up

Способ покупки, указанный в отзыве:

FeedbackFactorDTO - Up

Информация об оценках по параметрам, указанных в отзыве.

При создании отзыва автору предлагается поставить оценки магазину по нескольким параметрам: например, за скорость обработки заказа или удобство самовывоза. Набор параметров зависит от того, какой способ покупки (параметр delivery) указал автор.

id (optional)
Long Идентификатор параметра. format: int64
title (optional)
String Название параметра. Например, Скорость обработки заказа.
description (optional)
String Описание параметра. Например, Как быстро с вами связались для подтверждения заказа?.
value (optional)
Integer Оценка по параметру, указанная в отзыве: от 1 (низшая оценка) до 5 (высшая оценка). format: int32

FeedbackGradesDTO - Up

Информация об оценках, которые поставил автор отзыва магазину, и об оценках полезности отзыва от других пользователей Маркета.
average (optional)
BigDecimal Общая оценка, указанная в отзыве: от 1 («Ужасный магазин») до 5 («Отличный магазин»).
agreeCount (optional)
Long Количество пользователей, считающих отзыв полезным. format: int64
rejectCount (optional)
Long Количество пользователей, считающих отзыв бесполезным. format: int64
factors
array[FeedbackFactorDTO]

Информация об оценках по параметрам, указанных в отзыве.

При создании отзыва автору предлагается поставить оценки магазину по нескольким параметрам: например, за скорость обработки заказа или удобство самовывоза. Набор параметров зависит от того, какой способ покупки (параметр delivery) указал автор.

FeedbackListDTO - Up

Отзывы пользователей Яндекс Маркета об указанном магазине.
paging (optional)
feedbackList
array[FeedbackDTO]

Список отзывов.

Содержит не более 20 отзывов.

FeedbackOrderDTO - Up

Информация о заказе, указанная в отзыве.
shopOrderId (optional)
String Номер заказа, указанный в отзыве.
delivery (optional)

FeedbackReactionStatusType - Up

Статус реакции на отзыв:

FeedbackShopDTO - Up

Информация о магазине.
name (optional)
String Название магазина.

FeedbackStateType - Up

Статус отзыва:

FieldStateType - Up

Фильтр по заполненности или незаполненности поля:

FlippingPagerDTO - Up

Модель для пагинации.
total (optional)
Integer Сколько всего найдено элементов. format: int32
from (optional)
Integer Начальный номер найденного элемента на странице. format: int32
to (optional)
Integer Конечный номер найденного элемента на странице. format: int32
currentPage (optional)
Integer Текущая страница. format: int32
pagesCount (optional)
Integer Общее количество страниц. format: int32
pageSize (optional)
Integer Размер страницы. format: int32

ForwardScrollingPagerDTO - Up

Ссылка на следующую страницу.
nextPageToken (optional)
String Идентификатор следующей страницы результатов.

FulfillmentWarehouseDTO - Up

Склад Маркета (FBY).
id
Long Идентификатор склада. format: int64
name
String Название склада.
address (optional)

FulfillmentWarehousesDTO - Up

Список складов Маркета (FBY).
warehouses
array[FulfillmentWarehouseDTO] Список складов Маркета (FBY).

FullOutletDTO - Up

Информация о точке продаж.
name
String Название точки продаж.
type
coords (optional)
String

Координаты точки продаж.

Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.

Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.

isMain (optional)
Boolean

Признак основной точки продаж.

Возможные значения:

  • false — неосновная точка продаж.
  • true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате: +7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO]

Информация об условиях доставки для данной точки продаж.

Обязательный параметр, если параметр type=DEPOT или type=MIXED.

storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64
id (optional)
Long Идентификатор точки продаж, присвоенный Маркетом. format: int64
status (optional)
region (optional)
shopOutletId (optional)
String Идентификатор точки продаж, заданный магазином.
workingTime (optional)
String Рабочее время.
moderationReason (optional)
String Статус модерации.

FullOutletLicenseDTO - Up

Информация о лицензии.
id (optional)
Long

Идентификатор лицензии.

Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно.

Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре number.

format: int64
outletId (optional)
Long Идентификатор точки продаж, для которой действительна лицензия. format: int64
licenseType (optional)
number (optional)
String Номер лицензии.
dateOfIssue (optional)
Date

Дата выдачи лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если лицензия для точки продаж в Москве выдана 13 ноября 2017 года, то параметр должен иметь значение 2017-11-13T00:00:00+03:00.

Обязательный параметр.

Не может быть позже даты окончания срока действия, указанной в параметре dateOfExpiry.

format: date-time
dateOfExpiry (optional)
Date

Дата окончания действия лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если действие лицензии для точки продаж в Москве заканчивается 20 ноября 2022 года, то параметр должен иметь значение 2022-11-20T00:00:00+03:00.

Обязательный параметр.

Не может быть раньше даты выдачи, указанной в параметре dateOfIssue.

format: date-time
checkStatus (optional)
checkComment (optional)
String

Причина, по которой лицензия не прошла проверку.

Параметр возвращается, только если параметр checkStatus имеет значение FAIL.

GenerateBoostConsolidatedRequest - Up

Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date

GenerateCompetitorsPositionReportRequest - Up

Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
categoryId
Long Идентификатор категории. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date

GenerateGoodsFeedbackRequest - Up

Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64

GenerateGoodsMovementReportRequest - Up

Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор кампании. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

GenerateGoodsRealizationReportRequest - Up

Данные, необходимые для генерации отчета: идентификатор магазина и период, за который нужен отчет.
campaignId
Long Идентификатор кампании. format: int64
year
Integer Год. format: int32
month
Integer Номер месяца. format: int32

GenerateGoodsTurnoverRequest - Up

Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор кампании. format: int64
date (optional)
date Дата, за которую нужно рассчитать оборачиваемость. Если параметр не указан, используется текущая дата. format: date

GenerateMassOrderLabelsRequest - Up

Данные, необходимые для генерации файла.
businessId
Long Идентификатор кабинета. format: int64
orderIds
set[Long] Список идентификаторов заказов. format: int64

GeneratePricesReportRequest - Up

Данные, необходимые для генерации отчета.
businessId (optional)
Long

Идентификатор бизнеса.

В большинстве случаев обязателен. Не указывается, если задан campaignId.

format: int64
campaignId (optional)
Long

Идентификатор кампании.

Как правило, не используется. Передавайте только если в кабинете есть магазины с уникальными ценами и вы хотите получить отчет для них. В этом случае передавать businessId не нужно.

format: int64
categoryIds (optional)
array[Long] Фильтр по категориям на Маркете. format: int64
creationDateFrom (optional)
date

Фильтр по времени появления предложения — начало периода.

Формат даты: ДД-ММ-ГГГГ.

format: date
creationDateTo (optional)
date

Фильтр по времени появления предложения — окончание периода.

Формат даты: ДД-ММ-ГГГГ.

format: date

GenerateReportDTO - Up

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
reportId
String Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
estimatedGenerationTime
Long Ожидаемая продолжительность генерации в миллисекундах. format: int64

GenerateReportResponse - Up

Ответ на запрос генерации отчета.
status (optional)
result (optional)

GenerateShelfsStatisticsRequest - Up

Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
attributionType

GenerateShipmentListDocumentReportRequest - Up

Данные, необходимые для генерации документа.
campaignId
Long Идентификатор кампании. format: int64
shipmentId (optional)
Long Идентификатор отгрузки. format: int64
orderIds (optional)
array[Long] Фильтр по идентификаторам заказа в отгрузке. format: int64

GenerateShowsSalesReportRequest - Up

Данные, необходимые для генерации отчета.
businessId (optional)
Long

Идентификатор бизнеса.

Указывается, если нужно составить отчет по всем магазинам бизнеса. В запросе обязательно должен быть либо businessID, либо campaignId, но не оба сразу.

format: int64
campaignId (optional)
Long

Идентификатор кампании.

Указывается, если нужно составить отчет по конкретному магазину. В запросе обязательно должен быть либо businessID, либо campaignId, но не оба сразу.

format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
grouping

GenerateStocksOnWarehousesReportRequest - Up

Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор магазина. format: int64
warehouseIds (optional)
array[Long] Фильтр по идентификаторам складов (только модель FBY). Чтобы узнать идентификатор, воспользуйтесь запросом GET warehouses. format: int64
reportDate (optional)
date Фильтр по дате (для модели FBY). В отчет попадут данные за предшествующий дате день. format: date
categoryIds (optional)
array[Long] Фильтр по категориям на Маркете (кроме модели FBY). format: int64
hasStocks (optional)
Boolean Фильтр по наличию остатков (кроме модели FBY).

GenerateUnitedMarketplaceServicesReportRequest - Up

Данные, необходимые для генерации отчета: идентификатор магазина, период, за который нужен отчет, а также фильтры.
businessId
Long Идентификатор бизнеса. format: int64
dateTimeFrom (optional)
Date

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Начало периода, включительно.

format: date-time
dateTimeTo (optional)
Date

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Конец периода, включительно. Максимальный период — 1 год.

format: date-time
dateFrom (optional)
date Начало периода, включительно. format: date
dateTo (optional)
date Конец периода, включительно. Максимальный период — 1 год. format: date
yearFrom (optional)
Integer Начальный год формирования акта. format: int32
monthFrom (optional)
Integer Начальный номер месяца формирования акта. format: int32
yearTo (optional)
Integer Конечный год формирования акта. format: int32
monthTo (optional)
Integer Конечный номер месяца формирования акта. format: int32
placementPrograms (optional)
array[PlacementType] Список моделей, которые нужны в отчете.
inns (optional)
array[String] Список ИНН, которые нужны в отчете.
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64

GenerateUnitedNettingReportRequest - Up

Данные, необходимые для генерации отчета: идентификатор магазина, период, за который нужен отчет, а также фильтры.
businessId
Long Идентификатор бизнеса. format: int64
dateTimeFrom (optional)
Date

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Начало периода, включительно.

format: date-time
dateTimeTo (optional)
Date

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Конец периода, включительно. Максимальный период — 1 год.

format: date-time
dateFrom (optional)
date Начало периода, включительно. format: date
dateTo (optional)
date Конец периода, включительно. Максимальный период — 1 год. format: date
bankOrderId (optional)
Long Номер платежного поручения. format: int64
bankOrderDateTime (optional)
Date Дата платежного поручения. format: date-time
placementPrograms (optional)
array[PlacementType] Список моделей, которые нужны в отчете.
inns (optional)
array[String] Список ИНН, которые нужны в отчете.
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64

GenerateUnitedOrdersRequest - Up

Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. Максимальный период — 1 год. format: date
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64
promoId (optional)
String Идентификатор акции, товары из которой нужны в отчете.

GetAllOffersResponse - Up

Список предложений.
offers
array[OfferDTO] Список предложений магазина.

GetBidsInfoRequest - Up

description.
skus (optional)
array[String]

Список товаров, для которых нужно получить значения ставок.

Если список не задан, постранично возвращаются все товары со ставками.

Если список задан, результаты возвращаются одной страницей, а параметры page_token и limit игнорируются.

GetBidsInfoResponse - Up

description.
status (optional)
result (optional)

GetBidsInfoResponseDTO - Up

Список товаров с указанными ставками.
bids
array[SkuBidItemDTO] Страница списка товаров.
paging (optional)

GetBidsRecommendationsRequest - Up

description.
skus
array[String] Список товаров, для которых нужно получить рекомендации по ставкам.

GetBidsRecommendationsResponse - Up

description.
status (optional)
result (optional)

GetBidsRecommendationsResponseDTO - Up

Список товаров с рекомендованными ставками.
recommendations
array[SkuBidRecommendationItemDTO] Список товаров с рекомендованными ставками.

GetBusinessBuyerInfoResponse - Up

status (optional)
result (optional)

GetBusinessDocumentsInfoResponse - Up

status (optional)
result (optional)

GetBusinessSettingsInfoDTO - Up

Информация о кабинете и его настройках.
info (optional)
settings (optional)

GetBusinessSettingsResponse - Up

Ответ на запрос настроек кабинета.
status (optional)
result (optional)

GetCampaignLoginsResponse - Up

Ответ на запрос списка логинов, связанных с магазином.
logins
array[String] Список логинов.

GetCampaignOfferDTO - Up

Параметры размещения товара в магазине.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

quantum (optional)
available (optional)
Boolean Есть ли товар в продаже.
basicPrice (optional)
campaignPrice (optional)
status (optional)
errors (optional)
array[OfferErrorDTO] Ошибки, препятствующие размещению товара на витрине.
warnings (optional)
array[OfferErrorDTO] Предупреждения, не препятствующие размещению товара на витрине.

GetCampaignOffersRequest - Up

Фильтрации товаров

В запросе можно указать либо фильтр offerIds, либо любые другие фильтры товаров. Совместное использование фильтра offerIds с другими фильтрациями приведет к ошибке.

offerIds (optional)
array[String]

Идентификаторы товаров, информация о которых нужна.

{% note warning "Такой список возвращается только целиком" %}

Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.

Если вы запрашиваете информацию по конкретным SKU, не заполняйте:

  • page_token
  • limit

{% endnote %}

 

statuses (optional)
array[OfferCampaignStatusType] Фильтр по статусам товаров.
categoryIds (optional)
array[Integer] Фильтр по категориям на Маркете.
vendorNames (optional)
array[String] Фильтр по брендам.
tags (optional)
array[String] Фильтр по тегам.

GetCampaignOffersResponse - Up

Ответ на запрос списка товаров в магазине.
status (optional)
result (optional)

GetCampaignOffersResultDTO - Up

Список товаров в заданном магазине.
paging (optional)
offers
array[GetCampaignOfferDTO] Страница списка товаров.

GetCampaignRegionResponse - Up

Ответ на запрос региона магазина.
region (optional)

GetCampaignResponse - Up

Информация о магазине к данным идентификатора кампании.
campaign (optional)

GetCampaignSettingsResponse - Up

Ответ на запрос настроек магазина.
settings (optional)

GetCampaignsResponse - Up

Результаты поиска магазинов.
campaigns
array[CampaignDTO] Список с информацией по каждому магазину.
pager (optional)

GetCategoriesMaxSaleQuantumDTO - Up

Категории и лимит на установку кванта и минимального количества товаров.
results
array[MaxSaleQuantumDTO] Категории и лимит на установку кванта и минимального количества товаров.
errors (optional)
array[CategoryErrorDTO] Ошибки, которые появились из-за переданных категорий.

GetCategoriesMaxSaleQuantumRequest - Up

Список категорий, для которых нужно вернуть лимит на установку кванта и минимального количества товаров.
marketCategoryIds
set[Long] Идентификаторы листовых категории на Маркете — тех, у которых нет дочерних категорий. format: int64

GetCategoriesMaxSaleQuantumResponse - Up

status (optional)
results
array[MaxSaleQuantumDTO] Категории и лимит на установку кванта и минимального количества товаров.
errors (optional)
array[CategoryErrorDTO] Ошибки, которые появились из-за переданных категорий.

GetCategoriesRequest - Up

Параметры запроса категорий.
language (optional)

GetCategoriesResponse - Up

status (optional)
result (optional)

GetCategoryContentParametersResponse - Up

Ответ со списком характеристик для категории и их допустимыми значениями.
status (optional)
result (optional)

GetChatHistoryRequest - Up

Историю какого чата нужно получить — и начиная с какого сообщения.
messageIdFrom (optional)
Long Идентификатор сообщения, начиная с которого нужно получить все последующие сообщения. format: int64

GetChatHistoryResponse - Up

status (optional)
result (optional)

GetChatInfoDTO - Up

Информация о чатах.
chatId
Long Идентификатор чата. format: int64
orderId
Long Идентификатор заказа. format: int64
type
status
createdAt
Date

Дата и время создания чата.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.

format: date-time
updatedAt
Date Дата и время последнего сообщения в чате. format: date-time

GetChatsInfoDTO - Up

Список чатов.
chats
array[GetChatInfoDTO] Информация о чатах.
paging (optional)

GetChatsRequest - Up

Фильтры по чатам, которые нужно вернуть.
orderIds (optional)
array[Long] Фильтр по идентификаторам заказов на Маркете. format: int64
types (optional)
array[ChatType] Фильтр по типам чатов.
statuses (optional)
array[ChatStatusType] Фильтр по статусам чатов.

GetChatsResponse - Up

status (optional)
result (optional)

GetDeliveryServicesResponse - Up

Ответ на запрос списка служб доставки.
result (optional)

GetFeedIndexLogsResponse - Up

status (optional)
result (optional)

GetFeedResponse - Up

Ответ на запрос информации о прайс-листе.
feed (optional)

GetFeedbackListResponse - Up

status (optional)
result (optional)

GetFeedsResponse - Up

Ответ на запрос списка прайс-листов.
feeds
array[FeedDTO] Список прайс-листов.

GetFulfillmentWarehousesResponse - Up

status (optional)
result (optional)

GetGoodsFeedbackCommentsRequest - Up

Фильтр запроса комментариев отзыва.
feedbackId
Long Идентификатор отзыва. format: int64

GetGoodsFeedbackCommentsResponse - Up

status (optional)
result (optional)

GetGoodsFeedbackRequest - Up

Фильтр запроса отзывов в кабинете.
dateTimeFrom (optional)
Date

Начало периода. Не включительно.

Если параметр не указан, возвращается информация за 6 месяцев до указанной в dateTimeTo даты.

format: date-time
dateTimeTo (optional)
Date

Конец периода. Не включительно.

Если параметр не указан, используется текущая дата.

format: date-time
reactionStatus (optional)
ratingValues (optional)
set[Integer] Оценка товара. format: int32
modelIds (optional)
set[Long]

Фильтр по идентификатору модели товара.

Получить идентификатор модели можно с помощью одного из запросов:

format: int64
paid (optional)
Boolean Фильтр отзывов за баллы Плюса.

GetGoodsFeedbackResponse - Up

status (optional)
result (optional)

GetGoodsStatsRequest - Up

Запрос отчета по товарам.
shopSkus
set[String] Список ваших идентификаторов SKU.

GetGoodsStatsResponse - Up

Ответ на запрос отчета по товарам.
status (optional)
result (optional)

GetHiddenOffersResponse - Up

Ответ на запрос списка скрытий.
status (optional)
result (optional)

GetHiddenOffersResultDTO - Up

Список скрытых вами товаров.
paging (optional)
hiddenOffers
array[HiddenOfferDTO] Список скрытых товаров.

GetMappingDTO - Up

Информация о товарах в каталоге.
marketSku (optional)
Long SKU на Маркете. format: int64
marketSkuName (optional)
String

Название карточки товара.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketModelId (optional)
Long

Идентификатор модели на Маркете.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

format: int64
marketModelName (optional)
String

Название модели на Маркете.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketCategoryId (optional)
Long

Идентификатор категории на Маркете, в которую попал товар.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

format: int64
marketCategoryName (optional)
String

Название категории карточки на Маркете.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

GetModelsOffersResponse - Up

Ответ на запрос списка предложений для моделей.
models
array[EnrichedModelDTO] Список моделей товаров.
currency (optional)
regionId (optional)
Long

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.

format: int64

GetModelsRequest - Up

Запрос информации о моделях.
models
array[Long] Список моделей. format: int64

GetModelsResponse - Up

Ответ на запрос информации о моделях.
models
array[ModelDTO] Список моделей товаров.
currency (optional)
regionId (optional)
Long

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.

format: int64

GetOfferCardsContentStatusRequest - Up

offerIds (optional)
set[String] Идентификаторы товаров, информация о которых нужна.

⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cardStatuses (optional)
set[OfferCardStatusType]

Фильтр по статусам карточек.

Что такое карточка товара

categoryIds (optional)
set[Integer] Фильтр по категориям на Маркете. format: int32

GetOfferCardsContentStatusResponse - Up

Ответ со списком состояний товаров и пагинацией.
status (optional)
result (optional)

GetOfferDTO - Up

Параметры товара.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

marketCategoryId (optional)
Long

Идентификатор категории на Маркете, к которой вы относите свой товар.

Если не указать marketCategoryId, то маркетная категория будет определена автоматически.

При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.

Список категорий Маркета можно получить с помощью запроса POST categories/tree.

format: int64
category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

pictures (optional)
array[String]

Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.

Требования к ссылкам

  • Ссылок может быть до 30.
  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/images/sku12345.jpg

https://yadi.sk/i/NaBoRsimVOLov

/images/sku12345.jpg

https://www.dropbox.com/s/818f/tovar.jpg

Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.

Требования к изображениям

videos (optional)
array[String]

Ссылка (URL) на видео товара.

Максимальное количество ссылок — 6.

Требования к ссылке

  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/video/sku12345.avi

https://yadi.sk/i/NaBoRsimVOLov

/video/sku12345.avi

https://www.dropbox.com/s/818f/super-tovar.avi

Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.

Требования к видео

manuals (optional)
array[OfferManualDTO]

Список инструкций по использованию товара.

Максимальное количество инструкций — 6.

Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

manufacturerCountries (optional)
array[String]

Страна, где был произведен товар.

Записывайте названия стран так, как они записаны в списке.

weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String]

Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.

Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.

shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String

Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.

Обязательно укажите, если он есть.

certificates (optional)
array[String]

Номера документов на товар: сертификата, декларации соответствия и т. п.

Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.

boxCount (optional)
Integer

Количество грузовых мест.

Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.

Для товаров, занимающих одно место, не передавайте этот параметр.

format: int32
condition (optional)
type (optional)
downloadable (optional)
Boolean

Признак цифрового товара. Укажите true, если товар доставляется по электронной почте.

Как работать с цифровыми товарами

adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO]

{% note warning "" %}

Этот параметр устарел. При передаче характеристик используйте parameterValues.

{% endnote %}

Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.

basicPrice (optional)
purchasePrice (optional)
additionalExpenses (optional)
cofinancePrice (optional)
cardStatus (optional)
campaigns (optional)
array[OfferCampaignStatusDTO] Список магазинов, в которых размещен товар.
sellingPrograms (optional)
array[OfferSellingProgramDTO] Информация о том, какие для товара доступны модели размещения.
archived (optional)
Boolean Товар помещен в архив.

GetOfferMappingDTO - Up

Информация о товаре.
offer (optional)
mapping (optional)

GetOfferMappingEntriesResponse - Up

Ответ на запрос списка товаров в каталоге.
status (optional)
result (optional)

GetOfferMappingsRequest - Up

offerIds (optional)
array[String]

Идентификаторы товаров, информация о которых нужна.

{% note warning "Такой список возвращается только целиком" %}

Если вы запрашиваете информацию по конкретным SKU, не заполняйте:

  • page_token;
  • limit;
  • cardStatuses;
  • categoryIds;
  • vendorNames;
  • tags;
  • archived.

{% endnote %}

 

cardStatuses (optional)
array[OfferCardStatusType]

Фильтр по статусам карточек.

Что такое карточка товара

categoryIds (optional)
array[Integer] Фильтр по категориям на Маркете.
vendorNames (optional)
array[String] Фильтр по брендам.
tags (optional)
array[String] Фильтр по тегам.
archived (optional)
Boolean

Фильтр по нахождению в архиве.

Передайте true, чтобы получить товары, находящиеся в архиве. Если фильтр не заполнен или передано false, в ответе возвращаются товары, не находящиеся в архиве.

GetOfferMappingsResponse - Up

status (optional)
result (optional)

GetOfferMappingsResultDTO - Up

Информация о товарах.
paging (optional)
offerMappings
array[GetOfferMappingDTO] Информация о товарах.

GetOfferRecommendationsRequest - Up

offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с остальными фильтрами. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cofinancePriceFilter (optional)
recommendedCofinancePriceFilter (optional)
competitivenessFilter (optional)

GetOfferRecommendationsResponse - Up

status (optional)
result (optional)

GetOffersResponse - Up

Список предложений с пагинатором.
offers
array[OfferDTO] Список предложений магазина.
pager (optional)

GetOrderBuyerInfoResponse - Up

status (optional)
result (optional)

GetOrderLabelsDataResponse - Up

Ответ с информацией для печати ярлыков.
status (optional)
result (optional)

GetOrderResponse - Up

order (optional)

GetOrdersResponse - Up

Модель для ответа API списка информации по заказам.
pager (optional)
orders
array[OrderDTO] Модель заказа.
paging (optional)

GetOrdersStatsRequest - Up

Запрос информации по заказам.
dateFrom (optional)
date

Начальная дата, когда заказ был сформирован.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами updateFrom и updateTo.

format: date
dateTo (optional)
date

Конечная дата, когда заказ был сформирован.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами updateFrom и updateTo.

format: date
updateFrom (optional)
date

Начальная дата периода, за который были изменения статуса заказа.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами dateFrom и dateTo.

format: date
updateTo (optional)
date

Конечная дата периода, за который были изменения статуса заказа.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами dateFrom и dateTo.

format: date
orders (optional)
array[Long] Список идентификаторов заказов. format: int64
statuses (optional)
array[OrderStatsStatusType] Список статусов заказов.
hasCis (optional)
Boolean

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:

  • true — да.
  • false — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

GetOrdersStatsResponse - Up

Ответ на запрос информации по заказам.
status (optional)
result (optional)

GetOutletLicensesResponse - Up

status (optional)
result (optional)

GetOutletResponse - Up

Ответ на запрос информации о точке продаж.
outlet (optional)

GetOutletsResponse - Up

Ответ на запрос информации о точках продаж.
outlets
array[FullOutletDTO] Информация о точках продаж.
paging (optional)
pager (optional)

GetPriceDTO - Up

Цена с указанием времени последнего обновления.
value
BigDecimal Значение.
currencyId
updatedAt
Date Время последнего обновления. format: date-time

GetPriceWithDiscountDTO - Up

Цена с указанием скидки и времени последнего обновления.
value
BigDecimal Значение.
currencyId
discountBase (optional)
BigDecimal

Цена до скидки.

Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.

Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.

updatedAt
Date Время последнего обновления. format: date-time

GetPriceWithVatDTO - Up

Цена с указанием ставки НДС и времени последнего обновления.
value (optional)
BigDecimal Цена на товар.
discountBase (optional)
BigDecimal

Цена на товар без скидки.

Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.

Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.

currencyId (optional)
vat (optional)
Integer

Идентификатор ставки НДС, применяемой для товара:

  • 2 — 10%.
  • 5 — 0%.
  • 6 — не облагается НДС.
  • 7 — 20%.

Если параметр не указан, используется ставка НДС, установленная в кабинете.

format: int32
updatedAt
Date Время последнего обновления. format: date-time

GetPricesByOfferIdsRequest - Up

Запрос списка цен.
offerIds (optional)
array[String]

Список SKU.

{% note warning "Такой список возвращается только целиком" %}

Если вы запрашиваете информацию по конкретным SKU, не заполняйте:

  • page_token
  • limit

{% endnote %}

 

GetPricesByOfferIdsResponse - Up

Ответ на запрос списка цен.
status (optional)
result (optional)

GetPricesResponse - Up

Ответ на запрос списка цен.
status (optional)
result (optional)

GetPromoAssortmentInfoDTO - Up

Информация о товарах в акции.
activeOffers
Integer

Количество товаров, которые участвуют или участвовали в акции.

Учитываются только товары, которые были добавлены вручную.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

format: int32
potentialOffers (optional)
Integer

Количество доступных товаров в акции.

Параметр возвращается только для текущих и будущих акций.

format: int32
processing (optional)
Boolean

Есть ли изменения в ассортименте, которые еще не применились. Сохранение изменений занимает некоторое время.

Параметр возвращается только для текущих и будущих акций.

GetPromoBestsellerInfoDTO - Up

Информация об акции «Бестселлеры Маркета».
bestseller
Boolean Является ли акция «Бестселлером Маркета». Подробнее об этой акции читайте в Справке Маркета для продавцов.
entryDeadline (optional)
Date

До какой даты можно добавить товар в акцию «Бестселлеры Маркета».

Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».

format: date-time

GetPromoConstraintsDTO - Up

Ограничения в акции.
warehouseIds (optional)
array[Long]

Идентификаторы складов, для которых действует акция. Товары, которые лежат на других складах, не будут продаваться по акции.

Параметр возвращается, только если в условиях акции есть ограничение по складу.

format: int64

GetPromoDTO - Up

Информация об акции.
id
String Идентификатор акции.
name
String Название акции.
period
participating
Boolean

Участвует или участвовал ли продавец в этой акции.

Для текущих и будущих акций возвращается со значением true, если в акции есть товары, которые были добавлены вручную. Если товары не участвуют в акции или добавлены в нее автоматически, параметр возвращается со значением false.

Для прошедших акций всегда возвращается со значением true.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

assortmentInfo
mechanicsInfo
bestsellerInfo
channels (optional)
array[ChannelType] Список каналов продвижения товаров.
constraints (optional)

GetPromoMechanicsInfoDTO - Up

Информация о типе акции.
type
promocodeInfo (optional)

GetPromoOfferDTO - Up

Товар, который участвует или может участвовать в акции.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

status
params
autoParticipatingDetails (optional)

GetPromoOffersRequest - Up

Получение списка товаров, которые участвуют или могут участвовать в акции.
promoId
String Идентификатор акции.
statusType (optional)

GetPromoOffersResponse - Up

status (optional)
result (optional)

GetPromoOffersResultDTO - Up

Список товаров, которые участвуют или могут участвовать в акции.
offers
array[GetPromoOfferDTO] Товары, которые участвуют или могут участвовать в акции.
paging (optional)

GetPromoPromocodeInfoDTO - Up

Информация для типа MARKET_PROMOCODE.

Параметр заполняется только для этого типа акции.

promocode
String Промокод.
discount
Integer Процент скидки по промокоду. format: int32

GetPromosRequest - Up

Фильтры для получения списка акций.
participation (optional)
mechanics (optional)

GetPromosResponse - Up

status (optional)
result (optional)

GetPromosResultDTO - Up

Информация об акциях Маркета.
promos
array[GetPromoDTO] Акции Маркета.

GetQualityRatingDetailsResponse - Up

status (optional)
result (optional)

GetQualityRatingRequest - Up

Запрос информации по индексу качества.
dateFrom (optional)
date

Начало периода.

Формат даты: ГГГГ‑ММ‑ДД.

Не может быть раньше 30 дней от текущей даты.

format: date
dateTo (optional)
date

Конец периода.

Формат даты: ГГГГ‑ММ‑ДД.

Не может быть позже текущей даты.

format: date
campaignIds
set[Long] Список идентификаторов магазинов. format: int64

GetQualityRatingResponse - Up

Информация об индексе качества магазинов.
status (optional)
result (optional)

GetQuarantineOffersRequest - Up

Фильтрации товаров

В запросе можно указать либо фильтр offerIds, либо любые другие фильтры товаров. Совместное использование фильтра offerIds с другими фильтрациями приведет к ошибке.

offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна.

⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cardStatuses (optional)
array[OfferCardStatusType]

Фильтр по статусам карточек.

Что такое карточка товара

categoryIds (optional)
array[Integer] Фильтр по категориям на Маркете.
vendorNames (optional)
array[String] Фильтр по брендам.
tags (optional)
array[String] Фильтр по тегам.

GetQuarantineOffersResponse - Up

Ответ на запрос списка товаров в карантине.
status (optional)
result (optional)

GetQuarantineOffersResultDTO - Up

Список товаров в карантине.
paging (optional)
offers
array[QuarantineOfferDTO] Страница списка товаров в карантине.

GetRegionWithChildrenResponse - Up

pager (optional)
regions (optional)

GetRegionsResponse - Up

regions
array[RegionDTO] Регион доставки.
paging (optional)

GetReportInfoResponse - Up

Ответ на запрос информации об отчете.
status (optional)
result (optional)

GetReturnResponse - Up

status (optional)
result (optional)

GetReturnsResponse - Up

status (optional)
result (optional)

GetShipmentOrdersInfoResponse - Up

status (optional)
result (optional)

GetShipmentResponse - Up

status (optional)
result (optional)

GetSuggestedOfferMappingEntriesRequest - Up

Запрос рекомендованных карточек товара.
offers
array[MappingsOfferDTO] Список товаров.

GetSuggestedOfferMappingEntriesResponse - Up

Ответ со списком рекомендованных карточек товара.
status (optional)
result (optional)

GetSuggestedOfferMappingsRequest - Up

offers (optional)
array[SuggestedOfferDTO] Список товаров.

GetSuggestedOfferMappingsResponse - Up

status (optional)
result (optional)

GetSuggestedOfferMappingsResultDTO - Up

Подобранные карточки на Маркете.
offers
array[SuggestedOfferMappingDTO] Список товаров.

GetWarehouseStocksDTO - Up

Список складов с информацией об остатках на каждом из них.
paging (optional)
warehouses
array[WarehouseOffersDTO] Страница списка складов.

GetWarehouseStocksRequest - Up

Фильтры для запроса остатков.
withTurnover (optional)
Boolean

Только для модели FBY

Возвращать ли информацию по оборачиваемости.

Значение по умолчанию — false. Если информация нужна, передайте значение true.

archived (optional)
Boolean

Фильтр по нахождению в архиве.

Передайте true, чтобы получить информацию об остатках товаров, которые находятся в архиве. Если фильтр не заполнен или передано false, в ответе возвращается информация о товарах, которые не находятся в архиве.

offerIds (optional)
set[String]

Фильтр по вашим SKU товаров.

Возвращается информация об остатках всех переданных SKU, включая товары в архиве.

{% note warning "Такой список возвращается только целиком" %}

Если вы запрашиваете информацию по конкретным SKU, не заполняйте:

  • page_token
  • limit
  • archived

{% endnote %}

 

GetWarehouseStocksResponse - Up

status (optional)
result (optional)

GetWarehousesResponse - Up

status (optional)
result (optional)

GoodsFeedbackCommentAuthorDTO - Up

Информация об авторе комментария.
type (optional)
name (optional)
String Имя автора или название кабинета.

GoodsFeedbackCommentAuthorType - Up

Тип автора:

GoodsFeedbackCommentDTO - Up

Комментарий к отзыву.
id
Long Идентификатор комментария к отзыву. format: int64
text
String Текст комментария.
canModify (optional)
Boolean Может ли продавец изменять комментарий или удалять его.
parentId (optional)
Long Идентификатор комментария к отзыву. format: int64
author
status

GoodsFeedbackCommentListDTO - Up

Комментарии к отзыву.
comments
array[GoodsFeedbackCommentDTO] Список комментариев.
paging (optional)

GoodsFeedbackCommentStatusType - Up

Статус комментария:

GoodsFeedbackDTO - Up

Отзыв о товаре.
feedbackId
Long Идентификатор отзыва. format: int64
createdAt
Date Дата и время создания отзыва. format: date-time
needReaction
Boolean Нужен ли ответ на отзыв.
identifiers
author (optional)
String Имя автора отзыва.
description (optional)
media (optional)
statistics

GoodsFeedbackDescriptionDTO - Up

Текстовая часть отзыва.
advantages (optional)
String Описание плюсов товара в отзыве.
disadvantages (optional)
String Описание минусов товара в отзыве.
comment (optional)
String Комментарий в отзыве.

GoodsFeedbackIdentifiersDTO - Up

Идентификаторы, которые связаны с отзывом.
orderId
Long Идентификатор заказа на Маркете. format: int64
modelId
Long Идентификатор модели товара. format: int64

GoodsFeedbackListDTO - Up

Список отзывов о товарах.
feedbacks
array[GoodsFeedbackDTO] Список отзывов.
paging (optional)

GoodsFeedbackMediaDTO - Up

Фото и видео.
photos (optional)
array[String] Ссылки на фото.
videos (optional)
array[String] Ссылки на видео.

GoodsFeedbackStatisticsDTO - Up

Статистическая информация по отзыву.
rating
Integer Оценка товара. format: int32
commentsCount
Long

Количество комментариев к отзыву.

Учитываются только ответы на отзывы, а не дочерние комментарии.

format: int64
recommended (optional)
Boolean Рекомендуют ли этот товар.
paidAmount (optional)
Long Количество баллов Плюса, которое автор получил за отзыв. format: int64

GoodsStatsDTO - Up

Отчет по товарам.
shopSkus
array[GoodsStatsGoodsDTO] Список товаров.

GoodsStatsGoodsDTO - Up

Информация о товаре.
shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

marketSku (optional)
Long SKU на Маркете. format: int64
name (optional)
String Название товара.
price (optional)
BigDecimal Цена на товар в валюте, которая установлена в кабинете продавца на Маркете.
categoryId (optional)
Long Идентификатор категории товара на Маркете. format: int64
categoryName (optional)
String Название категории товара на Маркете.
weightDimensions (optional)
warehouses (optional)
array[GoodsStatsWarehouseDTO]

Информация о складах, на которых хранится товар.

Параметр не приходит, если товара нет ни на одном складе.

tariffs (optional)
array[TariffDTO]

Информация о тарифах, по которым нужно заплатить за услуги Маркета.

По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.

pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.

GoodsStatsWarehouseDTO - Up

Информация о складе.
id (optional)
Long Идентификатор склада. format: int64
name (optional)
String Название склада.
stocks
array[WarehouseStockDTO] Информация об остатках товаров на складе.

GoodsStatsWeightDimensionsDTO - Up

Информация о весе и габаритах товара.

Если товар уже привязан к карточке (marketSku), в ответе вернутся габариты из карточки Маркета, а не размеры, которые вы передаете.

length (optional)
BigDecimal Длина товара в сантиметрах.
width (optional)
BigDecimal Ширина товара в сантиметрах.
height (optional)
BigDecimal Высота товара в сантиметрах.
weight (optional)
BigDecimal Вес товара в килограммах.

GpsDTO - Up

GPS-координаты широты и долготы.
latitude
BigDecimal Широта. format: decimal
longitude
BigDecimal Долгота. format: decimal

HiddenOfferDTO - Up

Информация о скрытии.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

LanguageType - Up

Язык:

LicenseCheckStatusType - Up

Статус проверки лицензии:

LicenseType - Up

Тип лицензии:

LogisticPickupPointDTO - Up

Описание пункта вывоза для возврата.
id (optional)
Long Идентификатор пункта вывоза. format: int64
name (optional)
String Название пункта вывоза.
address (optional)
instruction (optional)
String Дополнительные инструкции к вывозу.
type (optional)
logisticPartnerId (optional)
Long Идентификатор логистического партнера, к которому относится логистическая точка. format: int64

LogisticPointType - Up

Тип логистической точки:

MappingsOfferDTO - Up

Информация о товарах в каталоге.
name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

id (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

urls (optional)
array[String]

URL фотографии товара или страницы с описанием на вашем сайте.

Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.

Должен содержать один вложенный параметр url.

pictures (optional)
array[String]

Ссылки (URL) изображений товара в хорошем качестве.

Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.

Обязательный параметр.

Должен содержать хотя бы один вложенный параметр picture.

manufacturer (optional)
String

Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).

Необязательный параметр.

manufacturerCountries (optional)
array[String]

Список стран, в которых произведен товар.

Обязательный параметр.

Должен содержать хотя бы одну, но не больше 5 стран.

minShipment (optional)
Integer

Минимальное количество единиц товара, которое вы поставляете на склад.

Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.

format: int32
transportUnitSize (optional)
Integer

Количество единиц товара в одной упаковке, которую вы поставляете на склад.

Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.

format: int32
quantumOfSupply (optional)
Integer

Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.

Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.

format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer

Сколько мест (если больше одного) занимает товар.

Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.

format: int32
customsCommodityCodes (optional)
array[String]

Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).

Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).

Может содержать только один вложенный код ТН ВЭД.

weightDimensions (optional)
supplyScheduleDays (optional)
array[DayOfWeekType] Дни недели, в которые продавец поставляет товары на склад.
shelfLifeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок годности: через сколько дней товар станет непригоден для использования.

format: int32
lifeTimeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.

format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String

Номер документа на товар.

Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция

price (optional)
BigDecimal Цена на товар в рублях.

MappingsOfferInfoDTO - Up

Базовая информация о товарах в каталоге.
name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

id (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

urls (optional)
array[String]

URL фотографии товара или страницы с описанием на вашем сайте.

Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.

Должен содержать один вложенный параметр url.

pictures (optional)
array[String]

Ссылки (URL) изображений товара в хорошем качестве.

Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.

Обязательный параметр.

Должен содержать хотя бы один вложенный параметр picture.

manufacturer (optional)
String

Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).

Необязательный параметр.

manufacturerCountries (optional)
array[String]

Список стран, в которых произведен товар.

Обязательный параметр.

Должен содержать хотя бы одну, но не больше 5 стран.

minShipment (optional)
Integer

Минимальное количество единиц товара, которое вы поставляете на склад.

Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.

format: int32
transportUnitSize (optional)
Integer

Количество единиц товара в одной упаковке, которую вы поставляете на склад.

Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.

format: int32
quantumOfSupply (optional)
Integer

Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.

Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.

format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer

Сколько мест (если больше одного) занимает товар.

Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.

format: int32
customsCommodityCodes (optional)
array[String]

Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).

Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).

Может содержать только один вложенный код ТН ВЭД.

weightDimensions (optional)
supplyScheduleDays (optional)
array[DayOfWeekType] Дни недели, в которые продавец поставляет товары на склад.
shelfLifeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок годности: через сколько дней товар станет непригоден для использования.

format: int32
lifeTimeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.

format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String

Номер документа на товар.

Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция

MaxSaleQuantumDTO - Up

Лимит на установку кванта и минимального количества товаров по категориям.
id
Long Идентификатор категории. format: int64
name (optional)
String Название категории.
maxSaleQuantum (optional)
Integer Лимит на установку кванта и минимального количества товаров.

MechanicsType - Up

Тип акции:

ModelDTO - Up

Модель товара.
id (optional)
Long Идентификатор модели товара. format: int64
name (optional)
String Название модели товара.
prices (optional)

ModelOfferDTO - Up

Информация о предложении.
discount (optional)
Integer Скидка на предложение в процентах. format: int32
name (optional)
String Наименование предложения.
pos (optional)
Integer Позиция предложения в выдаче Маркета на карточке модели. format: int32
preDiscountPrice (optional)
BigDecimal Цена предложения без скидки магазина.
price (optional)
BigDecimal Цена предложения без скидки, которую получает покупатель при оплате через Yandex Pay.
regionId (optional)
Long

Идентификатор региона предложения (регион, откуда доставляется товар).

Сначала показываются предложения, доставляемые из региона, указанного в запросе в параметре regionId. Предложения, доставляемые из других регионов, показываются после них.

format: int64
shippingCost (optional)
BigDecimal

Стоимость доставки товара в регион:

  • 0 — доставка осуществляется бесплатно.
  • -1 — магазин не осуществляет доставку этого товара (самовывоз).

Если стоимость доставки неизвестна, параметр не выводится.

shopName (optional)
String Название магазина (в том виде, в котором отображается на Маркете).
shopRating (optional)
Integer

Рейтинг магазина.

Возможные значения:

  • -1 — у магазинов, недавно появившихся на Маркете, рейтинг появляется не сразу. До момента появления рейтинга для таких магазинов возвращается значение -1.
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
format: int32
inStock (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

format: int32

ModelPriceDTO - Up

Информация о ценах на модель товара.
avg (optional)
BigDecimal Средняя цена предложения для модели в регионе.
max (optional)
BigDecimal Максимальная цена предложения для модели в регионе.
min (optional)
BigDecimal Минимальная цена предложения для модели в регионе.

ModelsDTO - Up

Список моделей товаров.
models
array[ModelDTO] Список моделей товаров.

OfferAvailabilityStatusType - Up

Планы по поставкам:

OfferCampaignStatusDTO - Up

Статус товара в магазине.
campaignId
Long Идентификатор кампании. format: int64
status

OfferCampaignStatusType - Up

Статус товара:

Что обозначает каждый из статусов

OfferCardDTO - Up

Информация о состоянии карточки товара.

Если поле mapping отсутствует в ответе, Маркет еще не успел обработать информацию о товаре. Чтобы определить категорию такого товара, повторите запрос через несколько минут.

offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

mapping (optional)
parameterValues (optional)
array[ParameterValueDTO] Список характеристик с их значениями.
cardStatus (optional)
contentRating (optional)
Integer Процент заполненности карточки. format: int32
recommendations (optional)
array[OfferCardRecommendationDTO]

Список рекомендаций к заполнению карточки.

Рекомендации Маркета помогают заполнять карточку так, чтобы покупателям было проще найти ваш товар и решиться на покупку.

errors (optional)
array[OfferErrorDTO] Ошибки в контенте, препятствующие размещению товара на витрине.
warnings (optional)
array[OfferErrorDTO] Связанные с контентом предупреждения, не препятствующие размещению товара на витрине.

OfferCardRecommendationDTO - Up

Рекомендация по заполнению карточки товара.
type
percent (optional)
Integer Процент выполнения рекомендации. Указывается для рекомендаций некоторых типов. format: int32

OfferCardRecommendationType - Up

Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары.

Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.

1. Рекомендации, относящиеся к основным параметрам

Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

Рекомендации по заполнению параметров в updateOfferMappings:

Рекомендуемые значения параметров описаны в Справке Яндекс Маркета для продавцов.

2. Рекомендации, относящиеся к характеристикам по категориям

Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.

Рекомендации:

3. Устаревшие рекомендации

OfferCardStatusType - Up

Статус карточки товара:

Что обозначает каждый из статусов

OfferCardsContentStatusDTO - Up

Список товаров с информацией о состоянии карточек.
offerCards
array[OfferCardDTO] Страница списка товаров с информацией о состоянии карточек.
paging (optional)

OfferConditionDTO - Up

Состояние уцененного товара.
type (optional)
quality (optional)
reason (optional)
String Описание товара. Подробно опишите дефекты, насколько они заметны и где их искать.

OfferConditionQualityType - Up

Внешний вид товара:

OfferConditionType - Up

Тип уценки:

REFURBISHED — специальное значение для одежды, обуви и аксессуаров. Используется только для уцененных товаров из этой категории. Другие значения для одежды, обуви и аксессуаров не используются.

OfferContentDTO - Up

Товар с указанными характеристиками.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

categoryId
Integer Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree. format: int32
parameterValues
array[ParameterValueDTO]

Список характеристик с их значениями.

С parameterValues обязательно передавайте marketCategoryId — идентификатор категории на Маркете, к которой относятся указанные характеристики товара.

При изменении характеристик передавайте только те, значение которых нужно обновить.

Чтобы удалить значение заданной характеристики, передайте ее parameterId с пустым value.

Максимальное количество характеристик — 300.

OfferContentErrorDTO - Up

Текст ошибки.
type
parameterId (optional)
Long Идентификатор характеристики, с которой связана ошибка. format: int64
message
String Текст ошибки.

OfferContentErrorType - Up

Типы ошибок:

OfferDTO - Up

Предложение.
price (optional)
BigDecimal

Цена предложения.

До версии 2.0 партнерского API у параметра был тип String.

feedId (optional)
Long

Идентификатор прайс-листа, содержащего предложение.

Параметр доступен начиная с версии 2.0 партнерского API.

format: int64
id (optional)
String

Идентификатор предложения из прайс-листа.

Параметр выводится, если в прайс-листе задан уникальный идентификатор. Если в прайс-листе содержится несколько предложений с одинаковыми идентификаторами, параметр id указывается только для первого из них, для остальных параметры id и feedId не выводятся.

Параметр доступен начиная с версии 2.0 партнерского API.

shopCategoryId (optional)
String

Идентификатор категории предложения, указанный магазином в прайс-листе.

Параметр выводится только для предложений, у которых указана категория в прайс-листе.

Параметр доступен начиная с версии 2.0 партнерского API.

marketCategoryId (optional)
Integer Идентификатор категории предложения в дереве категорий Маркета. Параметр доступен начиная с версии 2.0 партнерского API. format: int32
preDiscountPrice (optional)
BigDecimal Цена предложения без скидки.
discount (optional)
Integer Скидка на предложение в процентах. format: int32
cutPrice (optional)
Boolean

Является ли предложение уцененным:

  • true — да.
  • false — нет.

Параметр доступен начиная с версии 2.58 партнерского API.

url (optional)
String URL-адрес предложения на сайте магазина.
modelId
Long

Идентификатор модели Маркета, с которой соотнесено предложение.

Если предложение не соотнесено ни с какой карточкой модели, то параметр modelid содержит значение 0.

{% note info %}

Идентификатор модели присутствует в URL карточки модели в виде значения параметра product. Например: https://market.yandex.ru/product/13584121.

{% endnote %}

format: int64
name (optional)
String Наименование предложения.
currency (optional)
bid (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Ставка на клик.

cbid (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Ставка на клик.

fee (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Процент комиссии на товар при продаже по CPA.

blocked (optional)
Boolean

Признак блокировки предложения. Возможные значения:

  • false — предложение активно, параметр не выводится.
  • true — предложение заблокировано. Параметр выводится, если предложение заблокировано и не попадает в выдачу Маркета. Это может произойти из-за отключения магазина.

OfferErrorDTO - Up

Сообщение об ошибке, связанной с размещением товара.
message (optional)
String Тип ошибки.
comment (optional)
String Пояснение.

OfferForRecommendationDTO - Up

Информация о состоянии цены на товар.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

price (optional)
cofinancePrice (optional)
competitiveness (optional)
shows (optional)
Long Количество показов карточки товара за последние 7 дней. format: int64

OfferManualDTO - Up

Инструкция по использованию товара.
url
String Ссылка на инструкцию.
title (optional)
String Название инструкции, которое будет отображаться на карточке товара.

OfferMappingDTO - Up

Информация о текущей карточке товара на Маркете.
marketSku (optional)
Long SKU на Маркете. format: int64
modelId (optional)
Long

Идентификатор модели для текущей карточки товара на Маркете.

Например, две лопатки разных цветов имеют разные SKU на Маркете (параметр marketSku), но одинаковый идентификатор модели товара.

format: int64
categoryId (optional)
Long Идентификатор категории для текущей карточки товара на Маркете. format: int64

OfferMappingEntriesDTO - Up

Информация о товарах в каталоге.
paging (optional)
offerMappingEntries
array[OfferMappingEntryDTO] Информация о товарах в каталоге.

OfferMappingEntryDTO - Up

Список товаров.
mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)
offer (optional)

OfferMappingErrorDTO - Up

Текст ошибки.
type
parameterId (optional)
Long Идентификатор характеристики, с которой связана ошибка. format: int64
message
String Текст ошибки.

OfferMappingErrorType - Up

Типы ошибок:

OfferMappingInfoDTO - Up

Информация о карточке товара.
mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)

OfferMappingKindType - Up

Вид маппинга.

OfferMappingSuggestionsListDTO - Up

Список рекомендованных карточек товара.
offers
array[EnrichedMappingsOfferDTO] Список товаров.

OfferParamDTO - Up

Параметры товара.

Если у товара несколько значений одного параметра, передайте их с одним и тем же name, но разными value.

{% cut "Пример" %}

"params": [
  {
    "name": "Цвет",
    "value": "Зеленый"
  },
  {
    "name": "Цвет",
    "value": "Желтый"
  }
]

{% endcut %}

name
String

Название.

Должно совпадать с названием характеристики на Маркете. Узнать его можно из Excel-шаблона категории или через запрос POST category/{categoryId}/parameters.

value
String Значение.

OfferPriceByOfferIdsListResponseDTO - Up

Список цен.
offers
array[OfferPriceByOfferIdsResponseDTO] Страница списка цен.
paging (optional)

OfferPriceByOfferIdsResponseDTO - Up

Информация об установленной цене.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

price (optional)
updatedAt (optional)
Date Дата и время последнего обновления цены. format: date-time

OfferPriceDTO - Up

Товар с информацией о новой цене на него.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

price (optional)

OfferPriceListResponseDTO - Up

Список цен на товары.
offers
array[OfferPriceResponseDTO] Страница списка.
paging (optional)
total (optional)
Integer Количество всех цен магазина, измененных через API. format: int32

OfferPriceResponseDTO - Up

Информация об установленной цене на товар.
id (optional)
String Идентификатор предложения из прайс-листа.
price (optional)
marketSku (optional)
Long SKU на Маркете. format: int64
updatedAt (optional)
Date Дата и время последнего обновления цены на товар. format: date-time

OfferProcessingNoteDTO - Up

Причины, по которым товар не прошел модерацию.
type (optional)
payload (optional)
String Дополнительная информация о причине отклонения товара.

OfferProcessingNoteType - Up

Тип причины, по которой товар не прошел модерацию:

OfferProcessingStateDTO - Up

Информация о статусе публикации товара на Маркете.
status (optional)
notes (optional)
array[OfferProcessingNoteDTO] Причины, по которым товар не прошел модерацию.

OfferProcessingStatusType - Up

Статус публикации товара:

OfferRecommendationDTO - Up

Информация о состоянии цен и рекомендации.
offer (optional)
recommendation (optional)

OfferRecommendationInfoDTO - Up

Рекомендации, касающиеся цены на товар.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

recommendedCofinancePrice (optional)
competitivenessThresholds (optional)

OfferRecommendationsResultDTO - Up

Список товаров с рекомендациями.
paging (optional)
offerRecommendations
array[OfferRecommendationDTO] Страница списка товаров.

OfferSellingProgramDTO - Up

Информация о том, по каким моделям можно продавать товар, а по каким нельзя.
sellingProgram
status

OfferSellingProgramStatusType - Up

Информация о доступности или недоступности.

OfferType - Up

Особый тип товара:

{% note info "Если ваш товар — книга" %}

Укажите год издания в характеристиках товара. Подробнее о параметре

{% endnote %}

OfferWeightDimensionsDTO - Up

Габариты упаковки и вес товара.

Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.

Схема измерения многоместных грузов

length
BigDecimal Длина упаковки в см.
width
BigDecimal Ширина упаковки в см.
height
BigDecimal Высота упаковки в см.
weight
BigDecimal Вес товара в кг с учетом упаковки (брутто).

OffersDTO - Up

Найденные предложения магазина.
offers
array[OfferDTO] Список предложений магазина.

OptionValuesLimitedDTO - Up

Значение ограничивающей характеристики и список допустимых значений ограничиваемой характеристики.
limitingOptionValueId
Long Идентификатор значения ограничивающей характеристики. format: int64
optionValueIds
array[Long] Идентификаторы допустимых значений ограничиваемой характеристики. format: int64

OrderBoxLayoutDTO - Up

Информация о коробке.
items
array[OrderBoxLayoutItemDTO]

Список товаров в коробке.

Если в коробке едет часть большого товара, в списке может быть только один пункт.

OrderBoxLayoutItemDTO - Up

Информация о товаре в коробке.
id
Long

Идентификатор товара в заказе.

{% cut "Где его взять" %}

Идентификатор приходит в ответе на запрос GET campaigns/{campaignId}/orders/{orderId} и в запросе Маркета POST order/accept — параметр id в items.

{% endcut %}  

format: int64
fullCount (optional)
Integer

Количество единиц товара в коробке.

Используйте это поле, если в коробке поедут целые товары, не разделенные на части. Не используйте это поле одновременно с partialCount.

format: int32
partialCount (optional)
instances (optional)
array[BriefOrderItemInstanceDTO] Переданные вами коды маркировки.

OrderBoxLayoutPartialCountDTO - Up

Информация о части товара в коробке.
current
Integer Номер части, начиная с 1. format: int32
total
Integer На сколько всего частей разделен товар. format: int32

OrderBoxesLayoutDTO - Up

Распределение товаров по коробкам.
boxes
array[EnrichedOrderBoxLayoutDTO] Список коробок.

OrderBusinessBuyerDTO - Up

Информация о покупателе.
inn (optional)
String ИНН.
kpp (optional)
String КПП.
organizationName (optional)
String Наименование юридического лица.
organizationJurAddress (optional)
String Юридический адрес.

OrderBusinessDocumentsDTO - Up

Информация о документах.
upd (optional)
ukd (optional)
torgTwelve (optional)
sf (optional)
ksf (optional)

OrderBuyerBasicInfoDTO - Up

Информация о покупателе с базовыми полями.
id (optional)
String Идентификатор покупателя.
lastName (optional)
String Фамилия покупателя.
firstName (optional)
String Имя покупателя.
middleName (optional)
String Отчество покупателя.
type (optional)

OrderBuyerDTO - Up

Информация о покупателе.

Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.

id (optional)
String Идентификатор покупателя.
lastName (optional)
String Фамилия покупателя.
firstName (optional)
String Имя покупателя.
middleName (optional)
String Отчество покупателя.
type (optional)

OrderBuyerInfoDTO - Up

Информация о покупателе и его номере телефона.
id (optional)
String Идентификатор покупателя.
lastName (optional)
String Фамилия покупателя.
firstName (optional)
String Имя покупателя.
middleName (optional)
String Отчество покупателя.
type (optional)
phone (optional)
String

Подменный номер телефона покупателя. Подробнее о таких номерах читайте в Справке Маркета для продавцов.

Формат номера: +<код_страны><код_региона><номер_телефона>.

OrderBuyerType - Up

Тип покупателя:

OrderCancellationReasonType - Up

Варианты причин, по которым заказ не может быть отменен.

OrderCourierDTO - Up

Информация о курьере.
fullName (optional)
String Полное имя курьера.
phone (optional)
String Номер телефона курьера.
phoneExtension (optional)
String Добавочный номер телефона.
vehicleNumber (optional)
String Номер транспортного средства.
vehicleDescription (optional)
String Описание машины. Например, модель и цвет.

OrderDTO - Up

Заказ.
id (optional)
Long Идентификатор заказа. format: int64
status (optional)
substatus (optional)
creationDate (optional)
String format: date-dd-MM-yyyy-HH-mm-ss
updatedAt (optional)
String format: date-dd-MM-yyyy-HH-mm-ss
currency (optional)
itemsTotal (optional)
BigDecimal Платеж покупателя. format: decimal
deliveryTotal (optional)
BigDecimal Стоимость доставки. format: decimal
buyerItemsTotal (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел.

{% endnote %}

Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки.

format: decimal
buyerTotal (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел.

{% endnote %}

Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки.

format: decimal
buyerItemsTotalBeforeDiscount (optional)
BigDecimal

Стоимость всех товаров в заказе в валюте покупателя без учета стоимости доставки и до применения скидок по:

  • акциям;
  • купонам;
  • промокодам.
format: decimal
buyerTotalBeforeDiscount (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел.

{% endnote %}

Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки (buyerItemsTotalBeforeDiscount + стоимость доставки).

format: decimal
paymentType (optional)
paymentMethod (optional)
fake (optional)
Boolean

Тип заказа:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

items
array[OrderItemDTO] Список товаров в заказе.
subsidies (optional)
array[OrderSubsidyDTO] Список субсидий по типам.
delivery (optional)
buyer (optional)
notes (optional)
String Комментарий к заказу.
taxSystem (optional)
cancelRequested (optional)
Boolean

Только для модели DBS

Запрошена ли отмена.

expiryDate (optional)
String format: date-dd-MM-yyyy-HH-mm-ss

OrderDeliveryAddressDTO - Up

Адрес доставки.

Указывается, если type=DELIVERY, type=POST или type=PICKUP (адрес пункта выдачи).

country (optional)
String

Страна.

Обязательный параметр.

postcode (optional)
String

Почтовый индекс.

Указывается, если выбрана доставка почтой (delivery type=POST).

city (optional)
String

Город или населенный пункт.

Обязательный параметр.

district (optional)
String Район.
subway (optional)
String Станция метро.
street (optional)
String

Улица.

Обязательный параметр.

house (optional)
String

Дом или владение.

Обязательный параметр.

block (optional)
String Корпус или строение.
entrance (optional)
String Подъезд.
entryphone (optional)
String Код домофона.
floor (optional)
String Этаж.
apartment (optional)
String Квартира или офис.
phone (optional)
String

Телефон получателя заказа.

Обязательный параметр.

recipient (optional)
String

Фамилия, имя и отчество получателя заказа.

Обязательный параметр.

gps (optional)

OrderDeliveryDTO - Up

Информация о доставке.
id (optional)
String

Идентификатор доставки, присвоенный магазином.

Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart.

type (optional)
serviceName (optional)
String Наименование службы доставки.
price (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Стоимость доставки смотрите в параметре deliveryTotal.

{% endnote %}

Стоимость доставки в валюте заказа.

format: decimal
deliveryPartnerType (optional)
courier (optional)
dates (optional)
region (optional)
address (optional)
vat (optional)
deliveryServiceId (optional)
Long Идентификатор службы доставки. format: int64
liftType (optional)
liftPrice (optional)
BigDecimal Стоимость подъема на этаж. format: decimal
outletCode (optional)
String Идентификатор пункта самовывоза, присвоенный магазином.
outletStorageLimitDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
dispatchType (optional)
tracks (optional)
array[OrderTrackDTO] Информация для отслеживания перемещений посылки.
shipments (optional)
array[OrderShipmentDTO] Информация о посылках.
estimated (optional)
Boolean Приблизительная ли дата доставки.
eacType (optional)
eacCode (optional)
String Код подтверждения ЭАПП (для типа MERCHANT_TO_COURIER).

OrderDeliveryDateDTO - Up

Информация о новой дате доставки заказа.
toDate
date

Новая дата доставки заказа.

Формат даты: ГГГГ-ММ-ДД.

format: date

OrderDeliveryDateReasonType - Up

Причина переноса доставки заказа. Возможные причины изменения даты:

OrderDeliveryDatesDTO - Up

Диапазон дат доставки.
fromDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
toDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
fromTime (optional)
String

Начало интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Минимальное значение: 00:00.

format: time
toTime (optional)
String

Конец интервала времени доставки.

Передается только совместно с параметром type=DELIVERY.

Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).

Максимальное значение: 23:59.

format: time
realDeliveryDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy

OrderDeliveryDispatchType - Up

Способ отгрузки:

OrderDeliveryEacType - Up

Тип кода подтверждения ЭАПП:

OrderDeliveryPartnerType - Up

Тип сотрудничества со службой доставки в рамках конкретного заказа:

OrderDeliveryType - Up

Способ доставки заказа:

OrderDigitalItemDTO - Up

Ключ цифрового товара.
id
Long

Идентификатор товара в заказе.

Он приходит в ответе на запрос GET campaigns/{campaignId}/orders/{orderId} и в запросе Маркета POST order/accept — параметр id в items.

format: int64
code
String Сам ключ.
slip
String Инструкция по активации.
activate_till
date

Дата, до которой нужно активировать ключ. Если ключ действует бессрочно, укажите любую дату в отдаленном будущем.

Формат даты: ГГГГ-ММ-ДД.

format: date

OrderDocumentStatusType - Up

Статус документа:

OrderItemDTO - Up

Список товаров в заказе.
id (optional)
Long

Идентификатор товара в заказе.

Позволяет идентифицировать товар в рамках данного заказа.

format: int64
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

offerName (optional)
String Название товара.
price (optional)
BigDecimal Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр subsidies). format: decimal
buyerPrice (optional)
BigDecimal

Цена на товар в валюте покупателя. В цене уже учтены скидки по:

  • акциям;
  • купонам;
  • промокодам.
format: decimal
buyerPriceBeforeDiscount (optional)
BigDecimal

Стоимость товара в валюте покупателя до применения скидок по:

  • акциям;
  • купонам;
  • промокодам.
format: decimal
priceBeforeDiscount (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел.

{% endnote %}

Стоимость товара в валюте магазина до применения скидок.

format: decimal
count (optional)
Integer Количество единиц товара.
vat (optional)
shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

subsidy (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Вместо него используйте subsidies.

{% endnote %}

Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

  • по промокодам;
  • по купонам;
  • по баллам Плюса;
  • по акциям.

Передается в валюте заказа.

format: decimal
partnerWarehouseId (optional)
String

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Идентификатор склада в системе партнера, на который сформирован заказ.

promos (optional)
array[OrderItemPromoDTO] Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
instances (optional)
array[OrderItemInstanceDTO]

Информация о маркировке единиц товара.

Возвращаются данные для маркировки, переданные в запросе PUT campaigns/{campaignId}/orders/{orderId}/cis.

Если магазин еще не передавал коды для этого заказа, instances отсутствует.

details (optional)
array[OrderItemDetailDTO] Информация об удалении товара из заказа.
subsidies (optional)
array[OrderItemSubsidyDTO] Список субсидий по типам.
requiredInstanceTypes (optional)
array[OrderItemInstanceType] Список необходимых маркировок товара.

OrderItemDetailDTO - Up

Детали по товару в заказе.
itemCount (optional)
Long Количество единиц товара. format: int64
itemStatus (optional)
updateDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy

OrderItemInstanceDTO - Up

Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
cis (optional)
String Код идентификации единицы товара в системе «Честный ЗНАК» без криптохвоста.
cisFull (optional)
String Код идентификации единицы товара в системе «Честный ЗНАК» с криптохвостом.
uin (optional)
String УИН ювелирного изделия (16-значный код) Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.
rnpt (optional)
String

Регистрационный номер партии товара.

Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.

gtd (optional)
String

Грузовая таможенная декларация.

Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.

Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.

OrderItemInstanceModificationDTO - Up

Позиция в корзине, требующая маркировки.
id
Long

Идентификатор товара в заказе.

Он приходит в ответе на запрос GET campaigns/{campaignId}/orders/{orderId} и в запросе Маркета POST order/accept — параметр id в items.

format: int64
instances
array[BriefOrderItemInstanceDTO] Список кодов маркировки единиц товара.

OrderItemInstanceType - Up

Вид маркировки товара:

OrderItemModificationDTO - Up

Список товаров в заказе.

Если магазин не передал информацию о товаре во входных данных, он будет удален из заказа.

Обязательный параметр.

id
Long

Идентификатор товара в рамках заказа.

Получить идентификатор можно с помощью ресурсов GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}.

Обязательный параметр.

format: int64
count
Integer Новое количество товара. format: int32
instances (optional)
array[BriefOrderItemInstanceDTO]

Информация о маркировке единиц товара.

Передавайте в запросе все единицы товара, который подлежит маркировке.

Обязательный параметр, если в заказе есть товары, подлежащие маркировке в системе «Честный ЗНАК».

OrderItemPromoDTO - Up

Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
type
discount (optional)
BigDecimal Размер пользовательской скидки в валюте покупателя. format: decimal
subsidy (optional)
BigDecimal

Вознаграждение партнеру от Маркета за товар, проданный в рамках акции.

Передается в валюте заказа.

format: decimal
shopPromoId (optional)
String Идентификатор акции поставщика.
marketPromoId (optional)
String

Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.

Параметр передается, только если параметр type=MARKET_DEAL.

OrderItemStatusType - Up

Возвращенный или невыкупленный товар:

OrderItemSubsidyDTO - Up

Общее вознаграждение партнеру за все скидки на товар:

Передается в валюте заказа.

type (optional)
amount (optional)
BigDecimal Сумма субсидии. format: decimal

OrderItemSubsidyType - Up

Тип субсидии:

OrderItemsModificationRequestReasonType - Up

Причина обновления состава заказа.

OrderItemsModificationResultDTO - Up

Краткие сведения о промаркированных товарах. Параметр возвращается, если ответ OK.
items
array[BriefOrderItemDTO] Список позиций в заказе, подлежащих маркировке.

OrderLabelDTO - Up

Данные для печати ярлыка.
orderId
Long Идентификатор заказа. format: int64
placesNumber
Integer Количество коробок в заказе. format: int32
url
String

URL файла с ярлыками‑наклейками на все коробки в заказе.

Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/labels.

parcelBoxLabels
array[ParcelBoxLabelDTO] Информация на ярлыке.

OrderLiftType - Up

Тип подъема заказа на этаж:

OrderParcelBoxDTO - Up

Информация о грузоместе.
id (optional)
Long Идентификатор грузоместа. format: int64
fulfilmentId (optional)
String Идентификатор грузового места в информационной системе магазина.

OrderPaymentMethodType - Up

Способ оплаты заказа:

Значение по умолчанию: CASH_ON_DELIVERY.

OrderPaymentType - Up

Тип оплаты заказа:

Если параметр отсутствует, заказ будет оплачен при получении.

OrderPromoType - Up

Тип скидки:

Устаревшие типы:

OrderShipmentDTO - Up

Список посылок.

В параметре может указываться несколько посылок.

id (optional)
Long Идентификатор посылки, присвоенный Маркетом. format: int64
shipmentDate (optional)
String Формат даты: ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
shipmentTime (optional)
String

Только для модели Экспресс

Время, к которому магазин должен упаковать заказ и перевести его в статус READY_TO_SHIP. После смены статуса за заказом приедет курьер.

Поле может появиться не сразу. Запрашивайте информацию о заказе в течении 5–10 минут, пока оно не вернется.

Формат времени: 24-часовой, ЧЧ:ММ.

Если заказ сделан организацией, параметр не возвращается до согласования даты доставки.

tracks (optional)
array[OrderTrackDTO]

Только для модели DBS

Информация для отслеживания перемещений посылки.

boxes (optional)
array[OrderParcelBoxDTO] Список грузовых мест.

OrderStateDTO - Up

Информация по заказу.
id
Long Идентификатор заказа. format: int64
status
substatus (optional)

OrderStatsStatusType - Up

Текущий статус заказа:

OrderStatusChangeDTO - Up

Заказ.
status
substatus (optional)
delivery (optional)

OrderStatusChangeDeliveryDTO - Up

Информация о доставке.
dates (optional)

OrderStatusChangeDeliveryDatesDTO - Up

Диапазон дат доставки.
realDeliveryDate (optional)
date

Только для модели DBS

Фактическая дата доставки.

Когда передавать параметр realDeliveryDate:

  • Не передавайте параметр, если:

    • переводите заказ в любой статус, кроме PICKUP или DELIVERED;
    • меняете статус заказа на PICKUP или DELIVERED в день доставки — будет указана дата выполнения запроса.
  • Передавайте дату доставки, если переводите заказ в статус PICKUP или DELIVERED не в день доставки. Нельзя указывать дату доставки в будущем.

    {% note warning "Индекс качества" %}

    Передача статуса после установленного срока снижает индекс качества. О сроках читайте в Справке Маркета для продавцов.

    {% endnote %}

     

format: date

OrderStatusType - Up

Статус заказа:

Также могут возвращаться другие значения. Обрабатывать их не требуется.

OrderSubsidyDTO - Up

Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:

Передается в валюте заказа.

type (optional)
amount (optional)
BigDecimal Сумма субсидии. format: decimal

OrderSubsidyType - Up

Тип субсидии:

OrderSubstatusType - Up

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

Также могут возвращаться другие значения. Обрабатывать их не требуется.

OrderTaxSystemType - Up

Система налогообложения (СНО) магазина на момент оформления заказа:

OrderTrackDTO - Up

Информация о трек-номере посылки (DBS).
trackCode (optional)
String Трек‑номер посылки.
deliveryServiceId (optional)
Long Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. format: int64

OrderUpdateStatusType - Up

Изменился ли статус заказа:

OrderVatType - Up

Ставка налога на добавленную стоимость (НДС) на товар:

Используется только совместно с параметром payment-method=YANDEX.

OrdersShipmentInfoDTO - Up

Годные/негодные ярлыки по заказам в отгрузке.
orderIdsWithLabels
set[Long] Идентификаторы заказов в отгрузке, для которых можно распечатать ярлыки. format: int64
orderIdsWithoutLabels
set[Long] Идентификаторы заказов в отгрузке, для которых нельзя распечатать ярлыки. format: int64

OrdersStatsCommissionDTO - Up

Информация о стоимости услуг.
type (optional)
actual (optional)
BigDecimal Сумма в рублях, которая была выставлена в момент создания заказа и которую нужно оплатить. Точность — два знака после запятой.

OrdersStatsCommissionType - Up

Услуга:

OrdersStatsDTO - Up

Информация по заказам.
orders
array[OrdersStatsOrderDTO] Список заказов.
paging (optional)

OrdersStatsDeliveryRegionDTO - Up

Информация о регионе доставки.
id (optional)
Long Идентификатор региона доставки. format: int64
name (optional)
String Название региона доставки.

OrdersStatsDetailsDTO - Up

Информация об удалении товара из заказа.
itemStatus (optional)
itemCount (optional)
Long Количество товара со статусом, указанном в параметре itemStatus. format: int64
updateDate (optional)
date

Дата, когда товар получил статус, указанный в параметре itemStatus.

Формат даты: ГГГГ-ММ-ДД.

format: date
stockType (optional)

OrdersStatsItemDTO - Up

Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

offerName (optional)
String Название товара.
marketSku (optional)
Long SKU на Маркете. format: int64
shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

count (optional)
Integer

Количество единиц товара с учетом удаленных единиц.

Если из заказа удалены все единицы товара, он попадет только в список initialItems.

format: int32
prices (optional)
array[OrdersStatsPriceDTO] Цена или скидки на товар.
warehouse (optional)
details (optional)
array[OrdersStatsDetailsDTO] Информация об удалении товара из заказа.
cisList (optional)
array[String] Список кодов идентификации товара в системе «Честный ЗНАК».
initialCount (optional)
Integer Первоначальное количество единиц товара. format: int32
bidFee (optional)
Integer

Списанная ставка ближайшего конкурента.

Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.

format: int32
cofinanceThreshold (optional)
BigDecimal

Порог для скидок с Маркетом на момент оформления заказа. Что это такое?

Указан в рублях. Точность — два знака после запятой.

cofinanceValue (optional)
BigDecimal

Скидка с Маркетом. Что это такое?

Указана в рублях. Точность — два знака после запятой.

OrdersStatsItemStatusType - Up

Статус товара:

OrdersStatsOrderDTO - Up

Информация о заказе.
id (optional)
Long Идентификатор заказа. format: int64
creationDate (optional)
date

Дата создания заказа.

Формат даты: ГГГГ-ММ-ДД.

format: date
statusUpdateDate (optional)
Date

Дата и время, когда статус заказа был изменен в последний раз.

Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва).

format: date-time
status (optional)
partnerOrderId (optional)
String Идентификатор заказа в информационной системе магазина.
paymentType (optional)
fake (optional)
Boolean

Тип заказа:

  • false — настоящий заказ покупателя.

  • trueтестовый заказ Маркета.

deliveryRegion (optional)
items
array[OrdersStatsItemDTO] Список товаров в заказе после возможных изменений.
initialItems (optional)
array[OrdersStatsItemDTO] Список товаров в заказе до изменений.
payments
array[OrdersStatsPaymentDTO] Информация о денежных переводах по заказу.
commissions
array[OrdersStatsCommissionDTO] Информация о комиссиях за заказ.

OrdersStatsOrderPaymentType - Up

Тип оплаты заказа:

OrdersStatsPaymentDTO - Up

Информация о денежных переводах по заказу.
id (optional)
String Идентификатор денежного перевода.
date (optional)
date

Дата денежного перевода.

Формат даты: ГГГГ-ММ-ДД.

format: date
type (optional)
source (optional)
total (optional)
BigDecimal Сумма денежного перевода. Значение указывается в рублях независимо от способа денежного перевода. Точность — два знака после запятой.
paymentOrder (optional)

OrdersStatsPaymentOrderDTO - Up

Информация о платежном получении.
id (optional)
String Номер платежного поручения.
date (optional)
date

Дата платежного поручения.

Формат даты: ГГГГ‑ММ‑ДД.

format: date

OrdersStatsPaymentSourceType - Up

Способ денежного перевода:

OrdersStatsPaymentType - Up

Тип денежного перевода:

OrdersStatsPriceDTO - Up

Цена или скидки на товар.
type (optional)
costPerItem (optional)
BigDecimal Цена или скидка на единицу товара в заказе. Указана в рублях. Точность — два знака после запятой.
total (optional)
BigDecimal Суммарная цена или скидка на все единицы товара в заказе. Указана в рублях. Точность — два знака после запятой.

OrdersStatsPriceType - Up

Тип скидки или цена на товар:

OrdersStatsStockType - Up

Тип товара:

OrdersStatsWarehouseDTO - Up

Информация о складе, на котором хранится товар.
id (optional)
Long Идентификатор склада. format: int64
name (optional)
String Название склада.

OutletAddressDTO - Up

Адрес точки продаж.
regionId
Long

Идентификатор региона.

Идентификатор можно получить c помощью запроса GET regions.

{% note alert %}

При создании и редактировании точек продаж можно указывать только регионы типов TOWN (город), CITY (крупный город) и REPUBLIC_AREA (район субъекта федерации). Тип региона указан в выходных параметрах type запросов GET regions и GET regions/{regionId}.

{% endnote %}

format: int64
street (optional)
String Улица.
number (optional)
String Номер дома.
building (optional)
String Номер строения.
estate (optional)
String Номер владения.
block (optional)
String Номер корпуса.
additional (optional)
String Дополнительная информация.
km (optional)
Integer Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица. format: int32
city (optional)
String

{% note warning "" %}

Этот параметр устарел. Не используйте его. Город или населенный пункт возвращается в параметре regionId.

{% endnote %}

OutletDTO - Up

Информация о точке продаж.
name
String Название точки продаж.
type
coords (optional)
String

Координаты точки продаж.

Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.

Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.

isMain (optional)
Boolean

Признак основной точки продаж.

Возможные значения:

  • false — неосновная точка продаж.
  • true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате: +7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO]

Информация об условиях доставки для данной точки продаж.

Обязательный параметр, если параметр type=DEPOT или type=MIXED.

storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64

OutletDeliveryRuleDTO - Up

Информация об условиях доставки для данной точки продаж.
minDeliveryDays (optional)
Integer

Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 0 — доставка в день заказа.

Максимальное значение: 60.

Допустимые сроки доставки (разница между minDeliveryDays и maxDeliveryDays) зависят от региона.

Для доставки по своему региону разница не должна превышать двух дней. Например, если minDeliveryDays равно 1, то для maxDeliveryDays допускаются значения от 1 до 3.

Для доставки в другие регионы:

  • Если minDeliveryDays до 18 дней, разница не должна превышать четырех дней. Например, если minDeliveryDays равно 10, то для maxDeliveryDays допускаются значения от 10 до 14.
  • Если minDeliveryDays больше 18 дней, разница должна быть не больше чем в два раза. Например, если minDeliveryDays равно 21, то для maxDeliveryDays допускаются значения от 21 до 42.

Обязательный параметр, если type="DEPOT" или type="MIXED".

Взаимоисключающий с параметром unspecifiedDeliveryInterval.

format: int32
maxDeliveryDays (optional)
Integer

Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 0 — доставка в день заказа.

Максимальное значение: 60.

Допустимые сроки доставки (разница между minDeliveryDays и maxDeliveryDays) зависят от региона.

Для доставки по своему региону разница не должна превышать двух дней. Например, если minDeliveryDays равно 1, то для maxDeliveryDays допускаются значения от 1 до 3.

Для доставки в другие регионы:

  • Если minDeliveryDays до 18 дней, разница не должна превышать четырех дней. Например, если minDeliveryDays равно 10, то для maxDeliveryDays допускаются значения от 10 до 14.
  • Если minDeliveryDays больше 18 дней, разница должна быть не больше чем в два раза. Например, если minDeliveryDays равно 21, то для maxDeliveryDays допускаются значения от 21 до 42.

Обязательный параметр, если type="DEPOT" или type="MIXED".

Взаимоисключающий с параметром unspecifiedDeliveryInterval.

format: int32
deliveryServiceId (optional)
Long

Идентификатор службы доставки товаров в точку продаж.

Информацию о службе доставки можно получить с помощью запроса GET delivery/services.

format: int64
orderBefore (optional)
Integer

Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от minDeliveryDays до maxDeliveryDays.

Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от minDeliveryDays + 1 рабочий день до maxDeliveryDays + 1 рабочий день.

Значение по умолчанию: 24.

format: int32
priceFreePickup (optional)
BigDecimal Цена на товар, начиная с которой действует бесплатный самовывоз товара из точки продаж.
unspecifiedDeliveryInterval (optional)
Boolean

Признак доставки товаров в точку продаж на заказ.

Признак выставлен, если:

  • точный срок доставки в точку продаж заранее неизвестен (например, если магазин собирает несколько заказов для отправки в точку или населенный пункт);
  • все товары изготавливаются или поставляются на заказ.

Возможные значения:

  • true — товары доставляются в точку продаж на заказ.

Параметр указывается только со значением true.

Взаимоисключающий с параметрами minDeliveryDays и maxDeliveryDays.

OutletLicenseDTO - Up

Информация о лицензии.
id (optional)
Long

Идентификатор лицензии.

Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно.

Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре number.

format: int64
outletId (optional)
Long Идентификатор точки продаж, для которой действительна лицензия. format: int64
licenseType (optional)
number (optional)
String Номер лицензии.
dateOfIssue (optional)
Date

Дата выдачи лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если лицензия для точки продаж в Москве выдана 13 ноября 2017 года, то параметр должен иметь значение 2017-11-13T00:00:00+03:00.

Обязательный параметр.

Не может быть позже даты окончания срока действия, указанной в параметре dateOfExpiry.

format: date-time
dateOfExpiry (optional)
Date

Дата окончания действия лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если действие лицензии для точки продаж в Москве заканчивается 20 ноября 2022 года, то параметр должен иметь значение 2022-11-20T00:00:00+03:00.

Обязательный параметр.

Не может быть раньше даты выдачи, указанной в параметре dateOfIssue.

format: date-time

OutletLicensesResponseDTO - Up

Ответ на запрос информации о лицензиях для точек продаж.
licenses
array[FullOutletLicenseDTO] Список лицензий.

OutletResponseDTO - Up

Результат выполнения запроса. Выводится, если status="OK".
id (optional)
Long Идентификатор точки продаж, присвоенный Маркетом. format: int64

OutletStatusType - Up

Статус точки продаж.

Возможные значения:

OutletType - Up

Тип точки продаж.

Возможные значения:

OutletVisibilityType - Up

Состояние точки продаж.

Возможные значения:

OutletWorkingScheduleDTO - Up

Список режимов работы точки продаж.
workInHoliday (optional)
Boolean

Признак, работает ли точка продаж в дни государственных праздников.

Возможные значения:

  • false — точка продаж не работает в дни государственных праздников.
  • true — точка продаж работает в дни государственных праздников.
scheduleItems
array[OutletWorkingScheduleItemDTO] Список расписаний работы точки продаж.

OutletWorkingScheduleItemDTO - Up

Расписание работы точки продаж.
startDay
endDay
startTime
String

Точка продаж работает c указанного часа.

Формат: ЧЧ:ММ.

endTime
String

Точка продаж работает до указанного часа.

Формат: ЧЧ:ММ.

PageFormatType - Up

Размещение ярлыков на странице:

PagedReturnsDTO - Up

Возвраты.
paging (optional)
returns
array[ReturnDTO] Список возвратов.

PalletsCountDTO - Up

Количество палет в отгрузке.
planned (optional)
Integer Количество палет, которое заявил продавец. format: int32
fact (optional)
Integer Количество палет, которое приняли в сортировочном центре. format: int32

ParameterType - Up

Тип данных:

ParameterValueConstraintsDTO - Up

Ограничения на значения характеристик.
minValue (optional)
Double Минимальное число. format: double
maxValue (optional)
Double Максимальное число. format: double
maxLength (optional)
Integer Максимальная длина текста. format: int32

ParameterValueDTO - Up

Значение характеристики.

Вы можете указывать несколько значений одной характеристики при условии, что:

Для этого в parameterValues передавайте каждое значение отдельно — несколько объектов с параметрами parameterId, valueId и value. Параметр parameterId должен быть одинаковым.

parameterId
Long Идентификатор характеристики. format: int64
unitId (optional)
Long Идентификатор единицы измерения. Если вы не передали параметр unitId, используется единица измерения по умолчанию. format: int64
valueId (optional)
Long

Идентификатор значения.

Обязательно указывайте идентификатор, если передаете значение из перечня допустимых значений, полученного от Маркета.

Только для характеристик типа ENUM.

format: int64
value (optional)
String Значение.

ParameterValueOptionDTO - Up

Значение характеристики.
id
Long Идентификатор значения. format: int64
value
String Значение.
description (optional)
String Описание значения.

ParcelBoxDTO - Up

Элемент отображает одно грузовое место. Вложенные поля больше не используются, передавайте элемент пустым в запросах и не обращайте внимание на содержимое в ответах.
id (optional)
Long

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

format: int64
fulfilmentId (optional)
String

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

ParcelBoxLabelDTO - Up

Информация о ярлыке для коробки.
url
String Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label.
supplierName
String Юридическое название магазина.
deliveryServiceName
String Юридическое название службы доставки.
orderId
Long Идентификатор заказа в системе Маркета. format: int64
orderNum
String

Идентификатор заказа в информационной системе магазина.

Совпадает с orderId, если Маркету неизвестен номер заказа в системе магазина.

recipientName
String Фамилия и инициалы получателя заказа.
boxId
Long Идентификатор коробки. format: int64
fulfilmentId
String

Идентификатор коробки в информационной системе магазина.

Возвращается в формате: номер заказа на Маркете-номер коробки. Например, 7206821‑1, 7206821‑2 и т. д.

place
String Номер коробки в заказе. Возвращается в формате: номер места/общее количество мест.
weight
String

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Общая масса всех товаров в заказе. Возвращается в формате: weight кг.

deliveryServiceId
String Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services.
deliveryAddress (optional)
String Адрес получателя.
shipmentDate (optional)
String Дата отгрузки в формате dd.MM.yyyy.

ParcelDTO - Up

Информация о грузовых местах в заказе.
boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определяет количество мест по длине этого списка.

PartnerShipmentWarehouseDTO - Up

Данные о складе отправления.
id (optional)
Long Идентификатор склада отправления. format: int64
name (optional)
String Наименование склада отправления.
address (optional)
String Адрес склада отправления.

PaymentFrequencyType - Up

Частота выплат:

Подробнее о графике выплат читайте в Справке Маркета для продавцов.

PickupAddressDTO - Up

Адрес доставки.
country (optional)
String Страна.
city (optional)
String Город.
street (optional)
String Улица.
house (optional)
String Номер дома.
postcode (optional)
String Почтовый индекс.

PlacementType - Up

Модель, по которой работает магазин:

PriceCompetitivenessThresholdsDTO - Up

Максимальные значения цены, при которых она является привлекательной или умеренной.
optimalPrice (optional)
averagePrice (optional)

PriceCompetitivenessType - Up

Привлекательность цены:

PriceDTO - Up

Цена с указанием скидки, валюты и времени последнего обновления.
value (optional)
BigDecimal Цена на товар.
discountBase (optional)
BigDecimal

Цена на товар без скидки.

Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.

Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.

currencyId (optional)
vat (optional)
Integer

Идентификатор ставки НДС, применяемой для товара:

  • 2 — 10%.
  • 5 — 0%.
  • 6 — не облагается НДС.
  • 7 — 20%.

Если параметр не указан, используется ставка НДС, установленная в кабинете.

format: int32

PriceQuarantineVerdictDTO - Up

Причина попадания товара в карантин.
type (optional)
params
array[PriceQuarantineVerdictParameterDTO] Цена, из-за которой товар попал в карантин, и значения для сравнения. Конкретный набор параметров зависит от типа карантина.

PriceQuarantineVerdictParamNameType - Up

Имя параметра причины скрытия товара по цене.

PriceQuarantineVerdictParameterDTO - Up

Параметр карантина.
name
value
String Значение параметра.

PriceQuarantineVerdictType - Up

Типы карантина:

PriceRecommendationItemDTO - Up

Рекомендованная цена.
campaignId
Long Идентификатор кампании. format: int64
price
BigDecimal Рекомендованная цена на товар. Чтобы продвижение хорошо работало, цена на товар должна быть не выше этого значения. Подробно о рекомендованных ценах format: decimal

PriceSuggestDTO - Up

Тип цены.
type (optional)
price (optional)
BigDecimal Цена в рублях.

PriceSuggestOfferDTO - Up

Товар с ценами для продвижения.
marketSku (optional)
Long SKU на Маркете. format: int64
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

priceSuggestion (optional)
array[PriceSuggestDTO] Цены для продвижения.

PriceSuggestType - Up

Тип цены:

PromoOfferAutoParticipatingDetailsDTO - Up

Информация об автоматическом добавлении товара в акцию.

Причины, по которым товар не был добавлен автоматически в других магазинах, можно узнать в кабинете продавца на Маркете на странице акции.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

campaignIds (optional)
array[Long]

Магазины, в которых товар добавлен в акцию автоматически.

Возвращается, если статус товара в акции — PARTIALLY_AUTO.

format: int64

PromoOfferDiscountParamsDTO - Up

Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.
price (optional)
Long

Зачеркнутая цена — та, по которой товар продавался до акции.

Указывается в рублях.

Возвращается, только если товар участвует в акции.

format: int64
promoPrice (optional)
Long

Цена по акции — та, по которой вы хотите продавать товар.

Указывается в рублях.

Возвращается, только если товар участвует в акции.

format: int64
maxPromoPrice
Long

Максимально возможная цена для участия в акции.

Указывается в рублях.

Возвращается для всех товаров.

format: int64

PromoOfferParamsDTO - Up

Параметры товара в акции.

Возвращается параметр, который соответствует типу акции.

discountParams (optional)
promocodeParams (optional)

PromoOfferParticipationStatusFilterType - Up

Фильтр для товаров, которые добавлены в акцию вручную:

Если не передать параметр statusType, вернутся все товары.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

PromoOfferParticipationStatusType - Up

Статус товара в акции:

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

PromoOfferPromocodeParamsDTO - Up

Параметры товара в акции с типом MARKET_PROMOCODE.
maxPrice
Long

Максимально возможная цена для участия в акции до применения промокода.

Указывается в рублях.

Возвращается для всех товаров.

format: int64

PromoOfferUpdateWarningCodeType - Up

Предупреждение, которое появилось при добавлении товара:

PromoOfferUpdateWarningDTO - Up

Предупреждение, которое появилось при добавлении товара в акцию или изменении его цен.
code
campaignIds (optional)
array[Long]

Идентификаторы магазинов в кабинете, для которых получены предупреждения.

Не возвращается, если предупреждения действуют для всех магазинов в кабинете.

format: int64

PromoParticipationType - Up

Какие акции вернутся:

PromoPeriodDTO - Up

Время проведения акции.
dateTimeFrom
Date Дата и время начала акции. format: date-time
dateTimeTo
Date Дата и время окончания акции. format: date-time

ProvideOrderDigitalCodesRequest - Up

Запрос на передачу ключей цифровых товаров.
items
array[OrderDigitalItemDTO]

Список проданных ключей.

Если в заказе есть несколько одинаковых товаров (например, несколько ключей к одной и той же подписке), передайте каждый в виде отдельного элемента массива. id у этих элементов должен быть один и тот же.

ProvideOrderItemIdentifiersRequest - Up

items
array[OrderItemInstanceModificationDTO] Список позиций, требующих маркировки.

ProvideOrderItemIdentifiersResponse - Up

status (optional)
result (optional)

PutSkuBidsRequest - Up

description.
bids
array[SkuBidItemDTO] Список товаров и ставки для продвижения, которые на них нужно установить.

QualityRatingAffectedOrderDTO - Up

Информация о заказе, который повлиял на индекс качества.
orderId
Long Идентификатор заказа. format: int64
description
String Описание проблемы.
componentType

QualityRatingComponentDTO - Up

Составляющая индекса качества.
value
Double Значение составляющей в процентах. format: double
componentType

QualityRatingComponentType - Up

Составляющие индекса качества.

Для модели DBS:

Для моделей FBS и Экспресс:

Для модели FBY:

QualityRatingDTO - Up

Информация об индексе качества.
rating
Long Значение индекса качества. format: int64
calculationDate
date

Дата вычисления.

Формат даты: ГГГГ‑ММ‑ДД.

format: date
components
array[QualityRatingComponentDTO] Составляющие индекса качества.

QualityRatingDetailsDTO - Up

Информация о заказах, которые повлияли на индекс качества.
affectedOrders
array[QualityRatingAffectedOrderDTO] Список заказов, которые повлияли на индекс качества.

QuantumDTO - Up

Настройка продажи квантами.

Чтобы сбросить установленные ранее значения, передайте пустой параметр quantum.

{% cut "Пример" %}

{
  "offers": [
    {
      "offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
      "quantum": {}
    }
  ]
}

{% endcut %}

minQuantity (optional)
Integer

Минимальное количество единиц товара в заказе. Например, если указать 10, покупатель сможет добавить в корзину не меньше 10 единиц.

⚠️ Если количество товара на складе меньше заданного, ограничение не сработает и покупатель сможет его заказать.

format: int32
stepQuantity (optional)
Integer

На сколько единиц покупатель сможет увеличить количество товара в корзине.

Например, если задать 5, покупатель сможет добавить к заказу только 5, 10, 15, ... единиц товара.

⚠️ Если количество товара на складе не дотягивает до кванта, ограничение не сработает и покупатель сможет заказать количество, не кратное кванту.

format: int32

QuarantineOfferDTO - Up

Товар в карантине.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

currentPrice (optional)
lastValidPrice (optional)
verdicts (optional)
array[PriceQuarantineVerdictDTO] Причины попадания товара в карантин.

RecipientType - Up

Способ возврата товара покупателем:

RefundStatusType - Up

Cтатус возврата денег:

RegionDTO - Up

Регион доставки.
id (optional)
Long Идентификатор региона. format: int64
name
String Название региона.
type
parent (optional)
children (optional)
array[RegionDTO] Дочерние регионы.

RegionType - Up

Тип региона.

Возможные значения:

RegionalModelInfoDTO - Up

Региональная информация.
currency (optional)
regionId (optional)
Long

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.

format: int64

RejectedPromoOfferDeleteDTO - Up

Информация о товаре и ошибки, которые появились при его удалении.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

reason

RejectedPromoOfferDeleteReasonType - Up

Описание ошибки:

RejectedPromoOfferUpdateDTO - Up

Описание отклоненного изменения.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

reason

RejectedPromoOfferUpdateReasonType - Up

Причина отклонения изменения:

ReportFormatType - Up

Формат отчета:

ReportInfoDTO - Up

Статус генерации и ссылка на готовый отчет.
status
subStatus (optional)
generationRequestedAt
Date Дата и время запроса на генерацию. format: date-time
generationFinishedAt (optional)
Date Дата и время завершения генерации. format: date-time
file (optional)
String Ссылка на готовый отчет.
estimatedGenerationTime (optional)
Long Ожидаемая продолжительность генерации в миллисекундах. format: int64

ReportStatusType - Up

Статус генерации отчета:

ReportSubStatusType - Up

Подстатус генерации отчета:

ReturnDTO - Up

Возврат заказа.
id (optional)
Long Идентификатор возврата. format: int64
orderId (optional)
Long Номер заказа. format: int64
creationDate (optional)
Date Дата создания возврата клиентом. format: date-time
updateDate (optional)
Date Дата обновления возврата. format: date-time
refundStatus (optional)
logisticPickupPoint (optional)
shipmentRecipientType (optional)
shipmentStatus (optional)
refundAmount (optional)
Long Сумма возврата. format: int64
items
array[ReturnItemDTO] Список товаров в возврате.
returnType (optional)
fastReturn (optional)
Boolean Используется ли опция Быстрый возврат денег за дешевый брак.

ReturnDecisionDTO - Up

Решения по возвратам.
returnItemId (optional)
Long Идентификатор товара в возврате. format: int64
count (optional)
Integer Количество единиц товара. format: int32
comment (optional)
String Комментарий.
reasonType (optional)
subreasonType (optional)
decisionType (optional)
refundAmount (optional)
Long Сумма возврата. format: int64
partnerCompensation (optional)
Long Компенсация за обратную доставку. format: int64
images (optional)
array[String] Список хеш-кодов фотографий товара от покупателя.

ReturnDecisionReasonType - Up

Причины возврата:

ReturnDecisionSubreasonType - Up

Детали причин возврата:

ReturnDecisionType - Up

Решение по возврату:

ReturnInstanceDTO - Up

Логистическая информация по возврату.
stockType (optional)
status (optional)
cis (optional)
String Код идентификации единицы товара в системе «Честный ЗНАК».
imei (optional)
String Международный идентификатор мобильного оборудования.

ReturnInstanceStatusType - Up

Логистический статус конкретного товара.

ReturnInstanceStockType - Up

Тип остатка на складе.

ReturnItemDTO - Up

Список товаров в возврате.
marketSku (optional)
Long SKU на Маркете. format: int64
shopSku
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

count
Long Количество единиц товара. format: int64
decisions (optional)
array[ReturnDecisionDTO] Список решений по возврату.
instances (optional)
array[ReturnInstanceDTO] Список логистических позиций возврата.
tracks (optional)
array[TrackDTO] Список трек-кодов для почтовых отправлений.

ReturnRequestDecisionType - Up

Решение по возврату.

ReturnShipmentStatusType - Up

Статус передачи возврата:

ReturnType - Up

Тип заказа для фильтрации:

Если не указывать, в ответе будут и возвраты, и невыкупы.

ScrollingPagerDTO - Up

Информация о страницах результатов.
nextPageToken (optional)
String Идентификатор следующей страницы результатов.
prevPageToken (optional)
String Идентификатор предыдущей страницы результатов.

SearchModelsResponse - Up

models
array[ModelDTO] Список моделей товаров.
currency (optional)
regionId (optional)
Long

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.

format: int64
pager (optional)

SearchShipmentsRequest - Up

Запрос информации об отгрузках.
dateFrom
date

Начальная дата для фильтрации по дате отгрузки (включительно).

Формат даты: ДД-ММ-ГГГГ.

format: date
dateTo
date

Конечная дата для фильтрации по дате отгрузки (включительно).

Формат даты: ДД-ММ-ГГГГ.

format: date
statuses (optional)
set[ShipmentStatusType] Список статусов отгрузок.
orderIds (optional)
set[Long] Список идентификаторов заказов из отгрузок. format: int64
cancelledOrders (optional)
Boolean

Возвращать ли отмененные заказы.

Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.

SearchShipmentsResponse - Up

Ответ на запрос информации об отгрузках.
status (optional)
result (optional)

SearchShipmentsResponseDTO - Up

Информация об отгрузках.
shipments
array[ShipmentInfoDTO] Список с информацией об отгрузках.
paging (optional)

SellingProgramType - Up

Модель размещения:

SendMessageToChatRequest - Up

В какой чат нужно отправить сообщение и текст сообщения.
message
String Текст сообщения. Максимальная длина — 4096 символа.

SetFeedParamsRequest - Up

Запрос на обновление изменение параметров прайс-листа.
parameters
array[FeedParameterDTO]

Параметры прайс-листа.

Обязательный параметр.

SetOrderBoxLayoutRequest - Up

boxes
array[OrderBoxLayoutDTO] Список коробок.
allowRemove (optional)
Boolean Передайте true, если вы собираетесь удалить часть товаров из заказа.

SetOrderBoxLayoutResponse - Up

status (optional)
result (optional)

SetOrderDeliveryDateRequest - Up

dates
reason

SetOrderDeliveryTrackCodeRequest - Up

trackCode
String Трек‑номер посылки.
deliveryServiceId
Long Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. format: int64

SetOrderShipmentBoxesRequest - Up

boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определяет количество мест по длине этого списка.

SetOrderShipmentBoxesResponse - Up

status (optional)
result (optional)

SetReturnDecisionRequest - Up

Решения по позиции в возврате.
returnItemId
Long Идентификатор товара в возврате. format: int64
decisionType
comment (optional)
String

Комментарий к решению. Укажите:

  • для REFUND_MONEY_INCLUDING_SHIPMENT— стоимость обратной пересылки;

  • для REPAIR — когда вы устраните недостатки товара;

  • для DECLINE_REFUND — причину отказа;

  • для OTHER_DECISION — какое решение вы предлагаете.

SetShipmentPalletsCountRequest - Up

Запрос на передачу количества упаковок в отгрузке.
placesCount
Integer Количество упаковок в отгрузке. format: int32

ShelfsStatisticsAttributionType - Up

Тип атрибуции:

О том, какие данные в отчете зависят и не зависят от типа атрибуции, читайте в Справке Маркета для продавцов.

ShipmentActionType - Up

Действия с отгрузкой:

ShipmentBoxesDTO - Up

В ответе Маркет возвращает переданный вами список грузовых мест. Не обращайте на это поле внимания.
boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определил количество мест по длине этого списка.

ShipmentDTO - Up

Информация об отгрузке.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32
currentStatus (optional)
availableActions
set[ShipmentActionType] Доступные действия над отгрузкой.

ShipmentInfoDTO - Up

Список с информацией об отгрузках.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32
status (optional)
statusDescription (optional)
String Описание статуса отгрузки.
statusUpdateTime (optional)
Date Время последнего изменения статуса отгрузки. format: date-time

ShipmentPalletLabelPageFormatType - Up

Формат страницы:

ShipmentStatusChangeDTO - Up

Статус отгрузки.
status (optional)
description (optional)
String Описание статуса отгрузки.
updateTime (optional)
Date Время последнего изменения статуса отгрузки. format: date-time

ShipmentStatusType - Up

Статус отгрузки:

ShipmentType - Up

Способ отгрузки заказов:

ShowsSalesGroupingType - Up

Группировка данных отчета. Возможные значения:

SkipGoodsFeedbackReactionRequest - Up

Идентификаторы отзывов.
feedbackIds
set[Long] Список идентификаторов отзывов, на которые магазин не будет отвечать. format: int64

SkuBidItemDTO - Up

Список товаров и ставок на них.
sku
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

bid
Integer Значение ставки. format: int32

SkuBidRecommendationItemDTO - Up

Список товаров с рекомендованными ставками.
sku
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

bid
Integer Значение ставки. format: int32
bidRecommendations (optional)
array[BidRecommendationItemDTO] Список рекомендованных ставок с соответствующими долями показов. Чем больше ставка, тем большую долю показов она помогает получить.
priceRecommendations (optional)
array[PriceRecommendationItemDTO] Рекомендованные цены.

SortOrderType - Up

Направление сортировки.

Возможные значения:

SuggestOfferPriceDTO - Up

Товар, для которого требуется получить цены для продвижения.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

marketSku (optional)
Long SKU на Маркете. format: int64

SuggestPricesRequest - Up

Запрос на получение списка цен для продвижения.
offers
array[SuggestOfferPriceDTO] Список товаров.

SuggestPricesResponse - Up

Ответ на запрос списка цен для продвижения.
status (optional)
result (optional)

SuggestPricesResultDTO - Up

Результат запроса цен для продвижения.
offers
array[PriceSuggestOfferDTO] Список товаров с ценами для продвижения.

SuggestedOfferDTO - Up

Информация о товаре.
offerId (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

vendorCode (optional)
String Артикул товара от производителя.
basicPrice (optional)

SuggestedOfferMappingDTO - Up

Товар с соответствующей карточкой на Маркете.
offer (optional)
mapping (optional)

TariffDTO - Up

Информация о тарифах, по которым нужно заплатить за услуги Маркета.
type
percent (optional)
BigDecimal

{% note warning "" %}

Этот параметр устарел. Не используйте его.

{% endnote %}

Значение тарифа в процентах.

amount
BigDecimal Значение тарифа в рублях.
parameters
array[TariffParameterDTO] Параметры расчета тарифа.

TariffParameterDTO - Up

Детали расчета конкретной услуги Маркета.
name
String Название параметра.
value
String Значение параметра.

TariffType - Up

Услуга Маркета или дополнительный тариф к услуге размещения:

Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.

TimePeriodDTO - Up

Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит.
timePeriod
Integer Продолжительность в указанных единицах.
timeUnit
comment (optional)
String Комментарий.

TimeUnitType - Up

Единица измерения времени:

TrackDTO - Up

Информация о трек-номерах.
trackCode (optional)
String Трек-код почтового отправления.

TransferOrdersFromShipmentRequest - Up

Запрос переноса заказов из отгрузки.
orderIds
array[Long] Список заказов, которые вы не успеваете подготовить. format: int64

TurnoverDTO - Up

Информация об оборачиваемости товара.
turnover
turnoverDays (optional)
Double Значение в днях. Что это за число? format: double

TurnoverType - Up

Оценка оборачиваемости.

|enum|Диапазон оборачиваемости|Комментарий| |-|-|-| |LOW|turnoverDays ≥ 120|| |ALMOST_LOW|100 ≤ turnoverDays < 120|| |HIGH|45 ≤ turnoverDays < 100|| |VERY_HIGH|0 ≤ turnoverDays < 45|| |NO_SALES|—|Продаж нет.| |FREE_STORE|Любое значение.|Товары этой категории сейчас хранятся бесплатно.|

UnitDTO - Up

Единица измерения.
id
Long Идентификатор единицы измерения. format: int64
name
String Сокращенное название единицы измерения.
fullName
String Полное название единицы измерения.

UpdateBusinessOfferPriceDTO - Up

Товар с новой ценой.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

price

UpdateBusinessPricesRequest - Up

Запрос на установку базовых цен на товары.
offers
array[UpdateBusinessOfferPriceDTO] Список товаров с ценами.

UpdateCampaignOfferDTO - Up

Параметры размещения товара в магазине.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

quantum (optional)
available (optional)
Boolean Есть ли товар в продаже.
vat (optional)
Integer

Ставка НДС, применяемая для товара. Задается цифрой:

  • 2 — 10%.
  • 5 — 0%.
  • 6 — не облагается НДС.
  • 7 — 20%.

Если параметр не указан, используется ставка НДС, установленная в кабинете продавца на Маркете.

format: int32

UpdateCampaignOffersRequest - Up

Запрос на обновление предложений товаров магазина.
offers
array[UpdateCampaignOfferDTO] Параметры размещения товаров в заданном магазине.

UpdateGoodsFeedbackCommentDTO - Up

Комментарий к отзыву или другому комментарию.
id (optional)
Long Идентификатор комментария к отзыву. format: int64
parentId (optional)
Long Идентификатор комментария к отзыву. format: int64
text
String Текст комментария.

UpdateGoodsFeedbackCommentRequest - Up

Комментарий к отзыву.
feedbackId
Long Идентификатор отзыва. format: int64
comment

UpdateGoodsFeedbackCommentResponse - Up

status (optional)
result (optional)

UpdateMappingDTO - Up

Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (ТоварыКаталогЗагрузить товары).

По результатам проверки Маркет может привязать товар к более подходящей карточке.

marketSku (optional)
Long SKU на Маркете. format: int64

UpdateMappingsOfferDTO - Up

Информация о товарах в каталоге.
name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

shopSku (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

id (optional)
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

urls (optional)
array[String]

URL фотографии товара или страницы с описанием на вашем сайте.

Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.

Должен содержать один вложенный параметр url.

pictures (optional)
array[String]

Ссылки (URL) изображений товара в хорошем качестве.

Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.

Обязательный параметр.

Должен содержать хотя бы один вложенный параметр picture.

manufacturer (optional)
String

Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).

Необязательный параметр.

manufacturerCountries (optional)
array[String]

Список стран, в которых произведен товар.

Обязательный параметр.

Должен содержать хотя бы одну, но не больше 5 стран.

minShipment (optional)
Integer

Минимальное количество единиц товара, которое вы поставляете на склад.

Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.

format: int32
transportUnitSize (optional)
Integer

Количество единиц товара в одной упаковке, которую вы поставляете на склад.

Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.

format: int32
quantumOfSupply (optional)
Integer

Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.

Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.

format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer

Сколько мест (если больше одного) занимает товар.

Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.

format: int32
customsCommodityCodes (optional)
array[String]

Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).

Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).

Может содержать только один вложенный код ТН ВЭД.

weightDimensions (optional)
supplyScheduleDays (optional)
array[DayOfWeekType] Дни недели, в которые продавец поставляет товары на склад.
shelfLifeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок годности: через сколько дней товар станет непригоден для использования.

format: int32
lifeTimeDays (optional)
Integer

{% note warning "" %}

Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.

{% endnote %}

Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.

format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String

Номер документа на товар.

Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция

UpdateOfferContentRequest - Up

Запрос на установку новых значений для параметров.
offersContent
array[OfferContentDTO] Список товаров с указанными характеристиками.

UpdateOfferContentResponse - Up

Описывает проблемы, которые появились при сохранении товара.
status (optional)
results (optional)
array[UpdateOfferContentResultDTO]

Ошибки и предупреждения, которые появились при обработке переданных значений. Каждый элемент списка соответствует одному товару.

Если ошибок и предупреждений нет, поле не передается.

UpdateOfferContentResultDTO - Up

Ошибки и предупреждения, которые появились из-за переданных характеристик.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

errors (optional)
array[OfferContentErrorDTO] Ошибки — информация в каталоге не обновится.
warnings (optional)
array[OfferContentErrorDTO] Предупреждения — информация в каталоге обновится.

UpdateOfferDTO - Up

Параметры товара.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

name (optional)
String

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила

marketCategoryId (optional)
Long

Идентификатор категории на Маркете, к которой вы относите свой товар.

Если не указать marketCategoryId, то маркетная категория будет определена автоматически.

При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.

Список категорий Маркета можно получить с помощью запроса POST categories/tree.

format: int64
category (optional)
String

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

pictures (optional)
array[String]

Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.

Требования к ссылкам

  • Ссылок может быть до 30.
  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/images/sku12345.jpg

https://yadi.sk/i/NaBoRsimVOLov

/images/sku12345.jpg

https://www.dropbox.com/s/818f/tovar.jpg

Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.

Требования к изображениям

videos (optional)
array[String]

Ссылка (URL) на видео товара.

Максимальное количество ссылок — 6.

Требования к ссылке

  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

https://example-shop.ru/video/sku12345.avi

https://yadi.sk/i/NaBoRsimVOLov

/video/sku12345.avi

https://www.dropbox.com/s/818f/super-tovar.avi

Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.

Требования к видео

manuals (optional)
array[OfferManualDTO]

Список инструкций по использованию товара.

Максимальное количество инструкций — 6.

Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.

vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN

description (optional)
String

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила

manufacturerCountries (optional)
array[String]

Страна, где был произведен товар.

Записывайте названия стран так, как они записаны в списке.

weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String]

Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.

Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.

shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String

Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.

Обязательно укажите, если он есть.

certificates (optional)
array[String]

Номера документов на товар: сертификата, декларации соответствия и т. п.

Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.

boxCount (optional)
Integer

Количество грузовых мест.

Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.

Для товаров, занимающих одно место, не передавайте этот параметр.

format: int32
condition (optional)
type (optional)
downloadable (optional)
Boolean

Признак цифрового товара. Укажите true, если товар доставляется по электронной почте.

Как работать с цифровыми товарами

adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO]

{% note warning "" %}

Этот параметр устарел. При передаче характеристик используйте parameterValues.

{% endnote %}

Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.

parameterValues (optional)
array[ParameterValueDTO]

Список характеристик с их значениями.

С parameterValues обязательно передавайте marketCategoryId — идентификатор категории на Маркете, к которой относятся указанные характеристики товара.

При изменении характеристик передавайте только те, значение которых нужно обновить.

Чтобы удалить значение заданной характеристики, передайте ее parameterId с пустым value.

Максимальное количество характеристик — 300.

basicPrice (optional)
purchasePrice (optional)
additionalExpenses (optional)
cofinancePrice (optional)

UpdateOfferMappingDTO - Up

Информация о товаре.
offer
mapping (optional)

UpdateOfferMappingEntryDTO - Up

Список товаров.

В теле запроса можно передать от одного до 500 товаров.

Обязательный параметр.

mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)
offer (optional)

UpdateOfferMappingEntryRequest - Up

Запрос на обновление товаров.
offerMappingEntries
array[UpdateOfferMappingEntryDTO] Информация о товарах в каталоге.

UpdateOfferMappingResultDTO - Up

Ошибки и предупреждения, которые появились из-за переданных характеристик.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

errors (optional)
array[OfferMappingErrorDTO] Ошибки — информация в каталоге не обновится.
warnings (optional)
array[OfferMappingErrorDTO] Предупреждения — информация в каталоге обновится.

UpdateOfferMappingsRequest - Up

offerMappings
array[UpdateOfferMappingDTO] Перечень товаров, которые нужно добавить или обновить.
onlyPartnerMediaContent (optional)
Boolean

Будут использоваться только переданные вами изображения товаров.

Значение по умолчанию — false. Если вы хотите заменить изображения, которые добавил Маркет, передайте значение true.

UpdateOfferMappingsResponse - Up

Описывает проблемы, возникшие при сохранении товара.
status (optional)
results (optional)
array[UpdateOfferMappingResultDTO]

Ошибки и предупреждения, которые появились при обработке списка характеристик. Каждый элемент списка соответствует одному товару.

Если ошибок и предупреждений нет, поле не передается.

UpdateOrderItemRequest - Up

Запрос на обновление состава заказа.
items
array[OrderItemModificationDTO]

Список товаров в заказе.

Если магазин не передал информацию о товаре во входных данных, он будет удален из заказа.

Обязательный параметр.

reason (optional)

UpdateOrderStatusDTO - Up

Список заказов.
id (optional)
Long Идентификатор заказа. format: int64
status (optional)
substatus (optional)
updateStatus (optional)
errorDetails (optional)
String

Ошибка при изменении статуса заказа. Содержит описание ошибки и идентификатор заказа.

Возвращается, если параметр updateStatus принимает значение ERROR.

UpdateOrderStatusRequest - Up

order

UpdateOrderStatusResponse - Up

Информация об изменении статуса заказа.
order (optional)

UpdateOrderStatusesDTO - Up

Список заказов, статус которых обновился.
orders
array[UpdateOrderStatusDTO] Список с обновленными заказами.

UpdateOrderStatusesRequest - Up

Список заказов.
orders
array[OrderStateDTO] Список заказов.

UpdateOrderStatusesResponse - Up

status (optional)
result (optional)

UpdateOrderStorageLimitRequest - Up

Запрос на обновление срока хранения заказа в ПВЗ.
newDate
date

Новая дата, до которой заказ будет храниться в пункте выдачи.

Срок хранения можно увеличить не больше, чем на 30 дней.

Формат даты: ГГГГ-ММ-ДД.

format: date

UpdateOutletLicenseRequest - Up

Запрос на создание или изменение лицензий для точек продаж.
licenses
array[OutletLicenseDTO] Список лицензий. Обязательный параметр, должен содержать информацию хотя бы об одной лицензии.

UpdatePriceWithDiscountDTO - Up

Цена с указанием скидки.
value
BigDecimal Значение.
currencyId
discountBase (optional)
BigDecimal

Цена до скидки.

Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.

Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.

UpdatePricesRequest - Up

Запрос на установку цен на товары.
offers
array[OfferPriceDTO] Список товаров.

UpdatePromoOfferDTO - Up

Описание товаров, которые участвуют в акции.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

params (optional)

UpdatePromoOfferDiscountParamsDTO - Up

Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.

Обязательный параметр для акций с этими типами.

price (optional)
Long

Зачеркнутая цена — та, по которой товар продавался до акции.

Указывается в рублях.

Число должно быть целым.

format: int64
promoPrice (optional)
Long

Цена по акции — та, по которой вы хотите продавать товар.

Указывается в рублях.

Число должно быть целым.

format: int64

UpdatePromoOfferParamsDTO - Up

Параметры товара, который участвует в акции.
discountParams (optional)

UpdatePromoOffersRequest - Up

Добавление товаров в акцию или обновление их параметров.

Чтобы добавить товары в акцию или обновить параметры каких-то товаров, передайте их в параметре offers.

promoId
String Идентификатор акции.
offers
array[UpdatePromoOfferDTO] Товары, которые необходимо добавить в акцию или цены которых нужно изменить.

UpdatePromoOffersResponse - Up

Результат добавления товаров в акцию.
status (optional)
result (optional)

UpdatePromoOffersResultDTO - Up

Ошибки и предупреждения, которые появились при добавлении товаров в акцию.
rejectedOffers (optional)
array[RejectedPromoOfferUpdateDTO]

Изменения, которые были отклонены.

Возвращается, только если есть отклоненные изменения.

warningOffers (optional)
array[WarningPromoOfferUpdateDTO]

Изменения, по которым есть предупреждения. Они информируют о возможных проблемах. Информация о товарах обновится.

Возвращается, только если есть предупреждения.

UpdateStockDTO - Up

Информация об остатках одного товара на одном из складов.
sku
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

items
array[UpdateStockItemDTO] Информация об остатках товара.

UpdateStockItemDTO - Up

Информация об остатках товара.
count
Long Количество доступного товара. format: int64
updatedAt (optional)
Date Дата и время последнего обновления информации об остатках.

Если вы не передали параметр updatedAt, используется текущее время.

Формат даты и времени: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00. format: date-time

UpdateStocksRequest - Up

Запрос на изменение информации по остаткам товаров.
skus
set[UpdateStockDTO] Данные об остатках товаров.

UpdateTimeDTO - Up

Время последнего обновления.
updatedAt
Date Время последнего обновления. format: date-time

ValueRestrictionDTO - Up

Ограничение на возможные значения, накладываемое другой характеристикой.

Если ограничивающая характеристика принимает определенное значение, список возможных значений ограничиваемой характеристики сокращается.

Пример

Характеристика размер сама по себе может принимать девять разных значений: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.

Если ограничивающая характеристика размерная сетка принимает значение RU, список возможных значений размера сокращается до 44, 46, 48.

limitingParameterId
Long Идентификатор ограничивающей характеристики. format: int64
limitedValues
array[OptionValuesLimitedDTO] Значения ограничивающей характеристики и соответствующие допустимые значения текущей характеристики.

VerifyOrderEacRequest - Up

code (optional)
String Код для подтверждения ЭАПП.

VerifyOrderEacResponse - Up

status (optional)
result (optional)

WarehouseAddressDTO - Up

Адрес склада.
city
String Город.
street (optional)
String Улица.
number (optional)
String Номер дома.
building (optional)
String Номер строения.
block (optional)
String Номер корпуса.
gps

WarehouseDTO - Up

Информация о складе.
id
Long Идентификатор склада. format: int64
name
String Название склада.
campaignId
Long Идентификатор кампании в API и идентификатор магазина. format: int64
express
Boolean Возможна ли доставка по модели Экспресс.
address (optional)

WarehouseGroupDTO - Up

Информация о группе складов.
name
String Название группы складов.
mainWarehouse
warehouses
array[WarehouseDTO] Список складов, входящих в группу.

WarehouseOfferDTO - Up

Информация об остатках товара.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

turnoverSummary (optional)
stocks
array[WarehouseStockDTO] Информация об остатках.
updatedAt (optional)
Date

Дата и время последнего обновления информации об остатках.

Формат даты и времени: ISO 8601 со смещением относительно UTC. Например, 2023-11-21T00:42:42+03:00.

format: date-time

WarehouseOffersDTO - Up

Информация об остатках товаров на складе.
warehouseId
Long Идентификатор склада. format: int64
offers
array[WarehouseOfferDTO] Информация об остатках.

WarehouseStockDTO - Up

Информация об остатках товара.
type
count
Long Значение остатков. format: int64

WarehouseStockType - Up

Тип остатков товаров на складе:

WarehousesDTO - Up

Информация о складах и группах складов.
warehouses
array[WarehouseDTO] Список складов, не входящих в группы.
warehouseGroups
array[WarehouseGroupDTO] Список групп складов.

WarningPromoOfferUpdateDTO - Up

Описание предупреждения, которое появилось при добавлении товара.
offerId
String

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 255 знаков.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

warnings
array[PromoOfferUpdateWarningDTO] Предупреждения, которые появились при добавлении товара в акцию или изменении его цен.